leigh/neogen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docgen] Update doc/neogen.txt

Browse Source 
skip-checks: true
This commit is contained in:
github-actions
2025-02-19 10:51:25 +00:00
parent bc2325419e
commit eac6737a23
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/neogen.txt
View File

@@ -309,7 +309,7 @@ as well as providing custom configurations in order to be precise about
how to customize the annotations. how to customize the annotations.
Type ~ Type ~
neogen.TemplateConfig `(neogen.TemplateConfig)`
Default values: Default values:
@@ -327,7 +327,7 @@ Class ~
Fields ~ Fields ~
{annotation_convention} `(string)` select which annotation convention to use {annotation_convention} `(string)` select which annotation convention to use
{use_default_comment} `(boolean)` Prepend default filetype comment before a annotation {use_default_comment} `(boolean)` Prepend default filetype comment before a annotation
{append} `(optional)` neogen.TemplateConfig.Append custom placement of the annotation {append} `(optional)` `(neogen.TemplateConfig.Append)` custom placement of the annotation
{position} `(fun(node: userdata, type: string): number,number)` Provide an absolute position for the annotation {position} `(fun(node: userdata, type: string): number,number)` Provide an absolute position for the annotation
If values are `nil`, use default positioning If values are `nil`, use default positioning
@@ -335,7 +335,7 @@ Class ~
{neogen.TemplateConfig.Append} {neogen.TemplateConfig.Append}
{child_name} `(string)` Which child node to use for appending the annotation {child_name} `(string)` Which child node to use for appending the annotation
{fallback} `(string)` Node to fallback if `child_name` is not found {fallback} `(string)` Node to fallback if `child_name` is not found
{position} "'after'"|"'before'" Place the annotation relative to position with `child_name` or `fallback` {position} "'`(after)`'"|"'before'" Place the annotation relative to position with `child_name` or `fallback`
{disabled} `(optional)` `(table)` Disable custom placement for provided types {disabled} `(optional)` `(table)` Disable custom placement for provided types
For example, to customize the placement for a python annotation, we can use `append`, like so: For example, to customize the placement for a python annotation, we can use `append`, like so: