fix-members-short-description

Insert backslashes into multi-line Python member docstrings and enforce 88-character line limits.

16.4k|668|Updated Mar 24, 2022
One-click install
npx skills add https://github.com/flet-dev/flet --skill fix-members-short-description
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fix-members-short-description
Source: https://github.com/flet-dev/flet/tree/main/.codex/skills/fix-members-short-description
Command: npx skills add https://github.com/flet-dev/flet --skill fix-members-short-description

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill addresses the issue of incorrectly formatted multi-line docstring sentences in Python code, which can lead to documentation generation errors.

Core Features & Use Cases

  • Docstring Formatting: Correctly formats the first sentence of Python member docstrings when it spans multiple lines.
  • Line Length Enforcement: Ensures docstring lines do not exceed 88 characters, adding \ for line continuation.
  • Use Case: When generating API documentation from Python code, this skill ensures that short descriptions derived from docstrings are accurate and well-formatted, even if the original docstring was written across several lines.

Quick Start

Run the fix-members-short-description skill on the '/path/to/your/python/project' directory.

Frequently Asked Questions about fix-members-short-description

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix multi-line Python docstrings for API documentation generation?

To fix multi-line Python docstrings, you must correct the first sentence by inserting backslashes for proper string concatenation. This ensures generated API documentation accurately captures the short description without formatting errors.

What is the maximum line length for Python docstrings to prevent formatting errors?

The maximum line length for Python docstrings is 88 characters. Enforcing this limit ensures proper formatting by adding backslashes for line continuation when a docstring exceeds the threshold.

How do I format Python member docstrings that span multiple lines?

Formatting Python member docstrings that span multiple lines involves inserting backslashes to concatenate the first sentence. This targets Python codebases to maintain code quality and improve documentation generation.

Can I suppress line length errors for unbreakable tokens in Python docstrings?

Yes, you can suppress line length errors for unbreakable tokens in Python docstrings. While enforcing an 88-character limit, the tool provides an option to ignore errors when tokens cannot be split.

Why does my Python documentation generator output incorrect short descriptions?

Python documentation generators output incorrect short descriptions when multi-line first sentences in member docstrings are not properly concatenated. Inserting backslashes corrects the formatting and resolves the generation errors.