Agent skill
Global Commenting
Documentation and commenting standards for stock_picker_bot. Covers Python docstrings, type hints, and inline comments for complex financial calculations and API logic.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/global-commenting-adigunners-stock-picker-bot
SKILL.md
Global Commenting
This Skill provides Claude Code with specific guidance on how to adhere to coding standards as they relate to commenting and documentation in the stock_picker_bot project.
When to use this skill
Use this skill when:
- Writing docstrings for FastAPI endpoints explaining request parameters and responses
- Documenting SQLAlchemy models with field descriptions and relationships
- Adding type hints to functions for stock data processing and analysis
- Explaining complex financial calculations or technical indicators
- Documenting yfinance integration and data transformation logic
- Adding inline comments for non-obvious algorithm implementations
- Creating docstrings for utility functions handling portfolio calculations
- Documenting integration points with Google Generative AI and Claude APIs
Instructions
For details, refer to the information provided in this file: global commenting
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?