From fc7c72db77260b32192f9e0b50eb27d74b81683f Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Fri, 10 Feb 2023 08:58:07 +0100 Subject: [PATCH] Swift: tweaks to the schema doc documentation --- swift/schema_documentation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swift/schema_documentation.md b/swift/schema_documentation.md index ca965078f04..dfc686e2d4a 100644 --- a/swift/schema_documentation.md +++ b/swift/schema_documentation.md @@ -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("")` to the property specification, for example