Writing Clojure Docstrings

What problem does it solve?

This Skill provides comprehensive guidelines and best practices for writing effective, well-formatted docstrings in Clojure code, enhancing code readability and maintainability.

Core Features & Use Cases

• Markdown Formatting: Utilizes Markdown for rich text formatting within docstrings.
• Wikilinks: Enables cross-referencing functions, namespaces, and Java classes using [[wikilinks]].
• Code Examples: Demonstrates how to include small, illustrative code blocks.
• Table Documentation: Provides a clear method for documenting options maps using Markdown tables.
• Use Case: Ensure all new functions and namespaces have clear, consistent, and informative docstrings that adhere to established standards, making the codebase easier to understand for all developers.

Quick Start

Follow the guidelines in this skill to write a docstring for a new Clojure function.