kosslan/quickshell
1
0
Fork 0
forked from quickshell/quickshell
Code Pull requests Activity

docs: mention member reference syntax in CONTRIBUTING

Browse source
This commit is contained in:
outfoxxed 2024-07-21 17:44:09 -07:00
parent a9e4720fae
commit 14910b1b60
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E
1 changed files with 4 additions and 3 deletions

7
CONTRIBUTING.md
View file

@ -64,9 +64,10 @@ 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.
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.
You can reference other types using the `@@[Module.][Type.][member]` shorthand
where all parts are optional. If module or type are not specified they will
be inferred as the current module. Member can be a `property`, `function()` or `signal(s)`.
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.