From 14910b1b60713da40315554d66d2065d27f45a75 Mon Sep 17 00:00:00 2001 From: outfoxxed <outfoxxed@outfoxxed.me> Date: Sun, 21 Jul 2024 17:44:09 -0700 Subject: [PATCH] docs: mention member reference syntax in CONTRIBUTING --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c781462..feeb746b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.