Skip to content

Commit c5eec30

Browse files
author
Shati Patel
committed
Tidy up QLDoc spec
1 parent 2ce1ad1 commit c5eec30

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

docs/language/ql-spec/qldoc.rst

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

4-
This document is a specification for QLDoc comments in QL source files.
4+
This document is a formal specification for QLDoc comments.
5+
6+
About QLDoc comments
7+
--------------------
8+
9+
You can provide documentation for a QL entity by adding a QLDoc comment in the source file. The QLDoc comment is displayed as pop-up information in QL editors, for example when you hover over a predicate name.
510

611
Notation
712
--------
@@ -36,7 +41,7 @@ Content
3641

3742
The content of a QLDoc comment is interpreted as standard Markdown, with the following extensions:
3843

39-
- Fenced code blocks using \`s.
44+
- Fenced code blocks using backticks.
4045
- Automatic interpretation of links and email addresses.
4146
- Use of appropriate characters for ellipses, dashes, apostrophes, and quotes.
4247

0 commit comments

Comments
 (0)