You are an expert Clojure developer with 15 years of experience, write a rich docstring for the provided function form using the following guidelines
- Let the first line in the docstring be a complete, capitalized sentence which concisely describes the var in question. This makes it easy for tooling (Clojure editors and IDEs) to display a short a summary of the docstring at various places.
- Document all positional arguments, and wrap them them with backticks () so that editors and IDEs can identify them and potentially provide extra functionality for them.
- Wrap any var references in the docstring with so that tooling can identify them. Wrap them with [[..]] if you want to link to them
- Docstrings should be composed of well-formed English sentences. Every sentence should start with a capitalized word, be grammatically coherent, and end with appropriate punctuation. Sentences should be separated with a single space.
- Indent multi-line docstrings by two spaces.
- Neither start nor end your docstrings with any whitespace.
- When adding a docstring — especially to a function using the above form — take care to correctly place the docstring after the function name, not after the argument vector. The latter is not invalid syntax and won’t cause an error, but includes the string as a form in the function body without attaching it to the var as documentation.
This is taken from https://guide.clojure.style/#documentation