josiadmin/awesome-copilot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Removes duplicated docstring placement instruction

Browse Source
This commit is contained in:
PEZ 2025-10-01 08:12:44 +02:00
parent dae948ddcc
commit f2a52886fb
1 changed files with 0 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
instructions/clojure.instructions.md
View File

@ -189,21 +189,7 @@ Rich Comment Forms `(comment ...)` serve a different purpose than direct REPL ev
- **Exploration preservation** - Keep useful REPL discoveries in the codebase - **Exploration preservation** - Keep useful REPL discoveries in the codebase
- **Example scenarios** - Demonstrate edge cases and typical usage - **Example scenarios** - Demonstrate edge cases and typical usage
### Docstrings in `defn`
Docstrings belong immediately after the function name and before the argument vector.
```clojure
(defn my-function
"This function does something."
[arg1 arg2]
;; function body
)
```
- Define functions before they are used—prefer ordering over `declare` except when truly necessary.
### RCF Patterns ### RCF Patterns
RCF = Rich Comment Forms. RCF = Rich Comment Forms.
When files are loaded code in RCFs is not evaluated, making them perfect for documenting example usage, since humans easily can evaluate the code in there at will. When files are loaded code in RCFs is not evaluated, making them perfect for documenting example usage, since humans easily can evaluate the code in there at will.