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

docs: explain type reference shorthand in CONTRIBUTING

Browse source
This commit is contained in:
outfoxxed 2024-07-14 16:22:01 -07:00
parent e9cacbd92d
commit d1c33d48cd
Signed by untrusted user: outfoxxed
GPG key ID: 4C88A185FB89301E
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -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.