hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update guide to specify a full stop at the end of each reference

Browse Source
This commit is contained in:
Owen Mansel-Chan
2025-06-26 15:16:57 +01:00
parent 9f0f40d6ce
commit 297cdb53aa
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/query-help-style-guide.md
View File

@@ -100,7 +100,7 @@ Note, if any code words are included in the `overview` and `recommendation` sect
## Including references
You should include one or more references, formatted as an unordered list (`- ...` or `* ...`) in Markdown or with `<li> ... </li>` for each item in XML, to provide further information about the problem that your query is designed to find. References can be of the following types:
You should include one or more references, formatted as an unordered list (`- ...` or `* ...`) in Markdown or with `<li> ... </li>` for each item in XML, to provide further information about the problem that your query is designed to find. Each reference should end in a full stop. References can be of the following types:
### Books
@@ -124,7 +124,7 @@ If you are citing an academic paper, we recommend adopting the reference style o
If you are citing a website, please use the following format, without breadcrumb trails:
>\<Name of website>: \<Name of page or anchor>
>\<Name of website>: \<Name of page or anchor>.
For example: