Agent Skillsflet-dev/flet › fix-members-short-description

fix-members-short-description

GitHub

自动修复Python模块中类成员的文档字符串,确保首句多行拼接正确且每行不超过88字符,提升Flet文档生成的短描述质量。

.agents/skills/fix-members-short-description/SKILL.md flet-dev/flet

Trigger Scenarios

需要修复Python代码中的docstring格式 生成Flet文档前需预处理成员描述

Install

npx skills add flet-dev/flet --skill fix-members-short-description -g -y
More Options

Non-standard path

npx skills add https://github.com/flet-dev/flet/tree/main/.agents/skills/fix-members-short-description -g -y

Use without installing

npx skills use flet-dev/flet@fix-members-short-description

指定 Agent (Claude Code)

npx skills add flet-dev/flet --skill fix-members-short-description -a claude-code -g -y

安装 repo 全部 skill

npx skills add flet-dev/flet --all -g -y

预览 repo 内 skill

npx skills add flet-dev/flet --list

SKILL.md

Frontmatter
{
    "name": "fix-members-short-description",
    "description": "Use when asked to fix short descriptions of Python type members."
}

Inputs

  • File or directory with Python modules.

Instructions

When Flet documentation is generated from docstrings the first sentence of a member docstring is used as a short description, for example:

@dataclass
class MyControl:
    property_a: str
    """
    Short description of a property.

    Full description.
    Another line of full description.
    """

Here "Short description of a property." will be used as a short description.

However, when a sentence is broken into multiple lines the lines must be "concatenated" with \, for example:

@dataclass
class MyControl:
    property_a: str
    """
    Short description of a property which could \
    take multiple lines.

    Full description.
    Another line of full description.
    """

Your goal is to go through all members (properties, methods, etc.) of all types (classes, enums) in input file or directory and ensure the first sentence in their docstrings is broken into multiple lines correctly with \ symbol.

Apply the fix regardless of whether the first sentence starts on the same line as the opening """ or on a following line.

Ensure every docstring line is at most 88 characters long (including any trailing \). If a line cannot be wrapped without breaking a single unbreakable token (e.g., a long URL or Windows registry path like HKEY_LOCAL_MACHINE\\...), add # noqa: E501 to the docstring closing """ line instead of the long line.

Version History

  • 8f74fe9 Current 2026-08-20 12:12

Same Skill Collection

.agents/skills/create-flet-control-integration-tests/SKILL.md
.agents/skills/create-flet-example-projects/SKILL.md
.agents/skills/docs-build-and-verify/SKILL.md
.agents/skills/docs-conventions/SKILL.md
.agents/skills/flet-deprecation/SKILL.md
.agents/skills/imperative-to-declarative-flet/SKILL.md
.agents/skills/implement-flet-extension/SKILL.md
.agents/skills/prepare-flet-release/SKILL.md
.agents/skills/test-flet-apps-dev/SKILL.md
.agents/skills/update-flet-control-doc-gifs/SKILL.md
.agents/skills/write-changelog-entry/SKILL.md
website/.agents/skills/flet-release-announcement/SKILL.md
.agents/skills/run-unit-tests/SKILL.md
.agents/skills/run-integration-tests/SKILL.md

Metadata

Files
0
Version
b45d4a5
Hash
d9c4a17c
Indexed
2026-08-20 12:12

Accueil - Wiki
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-08-29 02:58
浙ICP备14020137号-1 $Carte des visiteurs$