Back to list
cvprun

doc-generator

by cvprun

Computer Vision Player

0🍴 0📅 Jan 23, 2026

SKILL.md


name: doc-generator description: Add Google-style docstrings to modules. Use for documentation requests. allowed-tools: Read, Glob, Grep, Edit

Documentation Generator

Add Google-style docstrings to cvp/ modules.

Format

def func(param1: int, param2: str) -> bool:
    """Brief description.

    Args:
        param1: Description.
        param2: Description.

    Returns:
        Description.

    Raises:
        ValueError: When invalid.
    """

Scope

  • Required: All public functions, classes, methods
  • Optional: Private functions (_ prefix) - brief only
  • Skip: __init__.py re-exports, simple getters/setters

Line Width

All docstrings and comments must not exceed 88 characters per line.

Validation

Ensure docstrings match type hints.

Score

Total Score

65/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

1ヶ月以内に更新

+10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon