docstring

Document a Python module and its classes using Google style

1.43x

Quality

55%

Does it follow best practices?

Impact

95%

1.43x

Average score across 3 eval scenarios

Securityby

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./.claude/skills/docstring/SKILL.md

Evaluation results

94%

34%

Document the Voice Activity Detection Module

Dataclass and Enum docstrings

Criteria

Without context

With context

Enum 'Parameters:' section

100%

Enum values described

100%

Dataclass 'Parameters:' section

100%

Dataclass fields described

100%

Module docstring present

50%

Constructor 'Initialize the' format

60%

100%

Constructor Args section

100%

Public methods documented

100%

Private methods undocumented

100%

Action-oriented writing

50%

75%

No redundant type info

100%

20%

Document the Frame Processor Base Class

Constructor and event handler docstrings

Criteria

Without context

With context

Constructor 'Initialize the' format

100%

Constructor Args section

100%

Event handlers in class docstring

100%

Event handler names without backticks

100%

Example:: double colon

100%

Example shows decorator pattern

100%

Existing docstring preserved

100%

Private methods undocumented

100%

__str__ undocumented

100%

Backticks for code references

100%

process_frame documented

100%

93%

33%

Document the ElevenLabs TTS Service Module

Method documentation and deprecation format

Criteria

Without context

With context

Deprecated class notice

100%

Deprecated version field

100%

Deprecated replacement named

87%

100%

Pass-through property undocumented

100%

Private methods undocumented

100%

run_tts Returns section

50%

100%

run_tts Args section

100%

Constructor 'Initialize the' format

75%

62%

No redundant type info

100%

Dataclass 'Parameters:' section

100%

Action-oriented writing

70%

60%

Repository: pipecat-ai/pipecat
Commit: ea296ba

Evaluated: 2 months ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

Document the Voice Activity Detection Module Document the Frame Processor Base Class Document the ElevenLabs TTS Service Module

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.