hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-27 09:45:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rename "QLDoc specification" to "QLDoc comment specification"

Browse Source
This commit is contained in:
Shati Patel
2020-02-13 12:57:17 +00:00
parent c846f536c4
commit 2ce1ad1818
3 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/language/ql-handbook/lexical-syntax.rst
View File

@@ -19,7 +19,7 @@ All standard one-line and multiline comments, as described in the `QL language s
compiler and are only visible in the source code.
You can also write another kind of comment, namely **QLDoc comments**. These comments describe
QL entities and are displayed as pop-up information in QL editors. For information about QLDoc
comments, see the `QLDoc specification <https://help.semmle.com/QL/ql-spec/qldoc.html>`_.
comments, see the `QLDoc comment specification <https://help.semmle.com/QL/ql-spec/qldoc.html>`_.
The following example uses these three different kinds of comments::

2
docs/language/ql-spec/index.rst
View File

@@ -6,7 +6,7 @@ QL specifications
For a formal specification of the QL language, including a description of syntax, terminology, and other technical details, please consult the QL language specification.
For information on the terminology and syntax used in QLDoc comments, please consult the QLDoc specification.
For information on the terminology and syntax used in QLDoc comments, please consult the QLDoc comment specification.
.. toctree::
:maxdepth: 2

4
docs/language/ql-spec/qldoc.rst
View File

@@ -1,5 +1,5 @@
QLDoc specification
===================
QLDoc comment specification
===========================
This document is a specification for QLDoc comments in QL source files.