hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-02-18 16:03:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4914 from alexet/fix-spec-bugs

Browse Source 
QL Language specification. Fix multiple spec bugs.
This commit is contained in:
Alexander Eyers-Taylor
2021-01-07 10:56:53 +00:00
committed by GitHub
parent 2c09f9a8f2 2686335531
commit 4100973d17
6 changed files with 158 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/codeql/writing-codeql-queries/metadata-for-codeql-queries.rst
View File

@@ -8,7 +8,7 @@ Metadata tells users important information about CodeQL queries. You must includ
About query metadata
--------------------
Any query that is run as part of an analysis includes a number of properties, known as query metadata. Metadata is included at the top of each query file as the content of a :ref:`QLDoc <qldoc-comment-specification>` comment.
Any query that is run as part of an analysis includes a number of properties, known as query metadata. Metadata is included at the top of each query file as the content of a QLDoc comment.
This metadata tells LGTM and the CodeQL :ref:`extension for VS Code <codeql-for-visual-studio-code>` how to handle the query and display its results correctly.
It also gives other users information about what the query results mean. For more information on query metadata, see the `query metadata style guide <https://github.com/github/codeql/blob/main/docs/query-metadata-style-guide.md>`__ in our `open source repository <https://github.com/github/codeql>`__ on GitHub.