Clojure Docstring Guidelines

Write clear, scannable docstrings using markdown formatting. All docstrings are interpreted as Markdown on cljdoc and Codox.

Core Principles

1. Backtick-Quote Arguments and Keywords

Use backticks around function arguments and special keywords to improve readability:

(defn conj!
  [coll x]
  "Adds `x` to the transient collection, and return `coll`. The 'addition'
   may happen at different 'places' depending on the concrete type."
  ,,,)

2. Link with [[Wikilinks]]