AI SummaryA plaintext-first docstring formatting specification for Python code that standardizes documentation style across projects. Developers writing or maintaining Python codebases benefit from consistent, readable documentation practices.
Install
Copy this and paste it into Claude Code, Cursor, or any AI assistant:
I want to install the "mdf-majo" skill in my project. Repository: https://github.com/majiayu000/claude-skill-registry Please read the repo to find the SKILL.md file(s), then: 1. Download them into the correct skills directory (.claude/skills/ or .cursor/skills/) 2. Include any companion files referenced by the skill 3. Confirm what was installed and where
Description
meadow Docstring Format (MDF) specification for Python documentation. Use when writing, editing, or reviewing docstrings for Python code. Provides a plaintext-first, readable format that closely follows Python syntax. Trigger when the user mentions docstrings, Python documentation, function documentation, class documentation, or writing documentation for Python code.
Format Overview
MDF docstrings are composed of sections in a specific order: | Section | Required | Position | Purpose | |---------|----------|----------|---------| | preamble | Yes | Start | One-line description | | body | No | Start or End | Longer explanation | | attributes/arguments/parameters | If applicable | Middle | Incoming signatures | | functions/methods | If applicable | Middle | Outgoing signatures | | returns | If not None | Middle | Return type with description | | raises | If applicable | Middle | Exceptions | | usage | No | Start or End | Code example |
6. Usage (Optional)
A markdown triple backtick block with usage examples: `python """ usage: `python cake = Cake(name="Chocolate", ingredients=[...]) result = cake.bake() ` """ `
Complex Class with Usage
`python class ModelBoundTOML(Generic[M]): """glue class for pydantic models and tomlkit documents attributes: model: BaseModel methods: `def __init__(self, model: type[M], documen
Goal
Standardize Python docstring formatting to be plaintext-first, readable, and closely aligned with Python syntax. MDF provides an intuitive documentation style that works across editors while maintaining clarity and consistency.
Discussion
Health Signals
My Fox Den
Community Rating
Sign in to rate this booster