mdf-majo

Community

Plain, readable Python docstrings with MDF.

Authormarkjoshwel
Version1.0.0
Installs0

System Documentation

What problem does it solve?

meadow Docstring Format (MDF) generalizes Python docstrings into a plaintext-first style that remains close to Python syntax, making documentation easier to write, read, and maintain.

Core Features & Use Cases

  • Standardizes docstring structure to include preamble, body, signatures, and usage
  • Enforces modern Python syntax (e.g., | unions, backtick-wrapped code) for clarity
  • Guides writing and reviewing Python documentation across modules, classes, and functions

Quick Start

Write a concise MDF-style docstring for a Python function to see MDF formatting in action.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: mdf-majo
Download link: https://github.com/markjoshwel/skills/archive/main.zip#mdf-majo

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.