docs: explain type reference shorthand in CONTRIBUTING
This commit is contained in:
parent
e9cacbd92d
commit
d1c33d48cd
1 changed files with 3 additions and 1 deletions
|
@ -64,7 +64,9 @@ Before submitting an MR, if adding new features please make sure the documentati
|
|||
reasonably using the `quickshell-docs` repo. We recommend checking it out at `/docs` in this repo.
|
||||
|
||||
Doc comments take the form `///` or `///!` (summary) and work with markdown.
|
||||
Look at existing code for how it works.
|
||||
You can reference other types using the `@@[Module].<Type>.[property]` shorthand
|
||||
where module and property are optional. If module is not specified it will
|
||||
be inferred as the current module. Look at existing code for how it works.
|
||||
|
||||
Quickshell modules additionally have a `module.md` file which contains a summary, description,
|
||||
and list of headers to scan for documentation.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue