Skip to content

Commit 2ce1ad1

Browse files
author
Shati Patel
committed
Rename "QLDoc specification" to "QLDoc comment specification"
1 parent c846f53 commit 2ce1ad1

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

docs/language/ql-handbook/lexical-syntax.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ All standard one-line and multiline comments, as described in the `QL language s
1919
compiler and are only visible in the source code.
2020
You can also write another kind of comment, namely **QLDoc comments**. These comments describe
2121
QL entities and are displayed as pop-up information in QL editors. For information about QLDoc
22-
comments, see the `QLDoc specification <https://help.semmle.com/QL/ql-spec/qldoc.html>`_.
22+
comments, see the `QLDoc comment specification <https://help.semmle.com/QL/ql-spec/qldoc.html>`_.
2323

2424
The following example uses these three different kinds of comments::
2525

docs/language/ql-spec/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ QL specifications
66

77
For a formal specification of the QL language, including a description of syntax, terminology, and other technical details, please consult the QL language specification.
88

9-
For information on the terminology and syntax used in QLDoc comments, please consult the QLDoc specification.
9+
For information on the terminology and syntax used in QLDoc comments, please consult the QLDoc comment specification.
1010

1111
.. toctree::
1212
:maxdepth: 2

docs/language/ql-spec/qldoc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
QLDoc specification
2-
===================
1+
QLDoc comment specification
2+
===========================
33

44
This document is a specification for QLDoc comments in QL source files.
55

0 commit comments

Comments
 (0)