docstring formats
Domain: Documentation
🎯 Motivation
docstring formats are conventions for writing documentation inside your code. Choosing a format like Google, NumPy, or Sphinx style ensures autodoc and IDEs render your docs consistently and beautifully.
📋 Concrete Example
A Google-style docstring uses Args: and Returns: sections, while NumPy style uses underlined headers. sphinx with napoleon can parse both into formatted HTML.
🔗 Analogy
docstring formats are like different essay templates (MLA, APA, Chicago). The content is yours, but the format determines how headings and citations are structured.