From d1c33d48cde52ce9416662052cb5136406d094f7 Mon Sep 17 00:00:00 2001
From: outfoxxed <outfoxxed@outfoxxed.me>
Date: Sun, 14 Jul 2024 16:22:01 -0700
Subject: [PATCH] docs: explain type reference shorthand in CONTRIBUTING

---
 CONTRIBUTING.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6fdef09c..9c781462 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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.