# 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.

- Skill: `majiayu000/global-commenting-7` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add majiayu000/global-commenting-7`
- Raw SKILL.md: https://api.skillmd.com/api/skills/majiayu000/global-commenting-7/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: majiayu000 (https://skillmd.com/u/majiayu000)
- Updated: 2026-09-09
- Page: https://skillmd.com/skills/majiayu000/global-commenting-7

---


# 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:

1. Writing docstrings for FastAPI endpoints explaining request parameters and responses
2. Documenting SQLAlchemy models with field descriptions and relationships
3. Adding type hints to functions for stock data processing and analysis
4. Explaining complex financial calculations or technical indicators
5. Documenting yfinance integration and data transformation logic
6. Adding inline comments for non-obvious algorithm implementations
7. Creating docstrings for utility functions handling portfolio calculations
8. Documenting integration points with Google Generative AI and Claude APIs

## Instructions

For details, refer to the information provided in this file:
[global commenting](../../../agent-os/standards/global/commenting.md)