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

Swift: tweaks to the schema doc documentation

Browse Source
This commit is contained in:
Paolo Tranquilli
2023-02-10 08:58:07 +01:00
parent adf47b9a9c
commit fc7c72db77
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
swift/schema_documentation.md
View File

@@ -11,7 +11,7 @@ class ErrorElement(Locatable):
```
This gets copied verbatim as QL doc comments for the class (with some internal handling for preservation of indentation,
as explained in https://peps.python.org/pep-0257/#handling-docstring-indentation)
as explained in https://peps.python.org/pep-0257/#handling-docstring-indentation).
## Properties
@@ -25,7 +25,7 @@ example property `name` in class `File` will get documented as
```
This documentation generation will expand common abbreviations. The list of expanded abbreviations can be found
in `swift/codegen/generators/qlgen.py`.
in [`codegen/generators/qlgen.py`](./codegen/generators/qlgen.py) as a dictionary under the `abbreviations` variable.
The `name of this file` part in the example above can be customized by appending `| doc("<replacement>")` to the
property specification, for example