docstring generator skill

Documentation Community

Skill notes

What I do

I generate language-specific docstrings and documentation following industry standards: Detect Language: Analyze file extension and project structure to determine language Detect Docstring Style: Identify existing docstring conventions in codebase Generate Docstrings: Create appropriate docstrings following language conventions Support Multiple Formats:

When to use me

Use this workflow when: Implementing new functions, classes, or methods in Python, Java, TypeScript, or C# Refactoring code and updating documentation Creating new APIs or public interfaces Following documentation best practices and industry standards

Prerequisites

Source code files (.py, .java, .ts, .tsx, .cs, .csx) File permissions to read and write files Knowledge of preferred docstring style (optional, can auto-detect) For workflow integration: Git repository initialized

Python

Standard: PEP 257 compliant Supported Styles: Google Style (recommended for most projects) NumPy Style (for scientific computing) Sphinx/reST Style (for documentation generation)

Java

Standard: Javadoc Supported Tags: @param - Parameter documentation @return / @returns - Return value documentation @throws - Exception documentation

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Documentation
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@tomevault-io · no license declared
Token usage
Moderate
Setup complexity
Guided setup
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
Python >=3.5
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

01
Step 1: Detect Language

Analyze file to determine programming language:

02
Step 2: Detect Docstring Style

Analyze existing docstrings in codebase to maintain consistency:

03
Step 3: Analyze Function/Method

Extract function signature and determine docstring needs:

04
Step 4: Generate Docstring

Generate appropriate docstring based on language and style: Python (Google Style) Java (Javadoc) TypeScript (JSDoc) C# (XML Documentation)

05
Step 5: Update File

Insert docstring into the correct location in the file:

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.