Skip to content

Improve docstring coverage to meet 80% threshold #276

Description

@sheepdestroyer

Description

CodeRabbit flagged that the repo's docstring coverage is ~25%, well below the 80%
threshold required by pre-merge checks.

Context

Noticed during review of PR #275 (sys.path import cleanup). The PR itself didn't
introduce or worsen the gap — this is a pre-existing global concern.

Scope

The repo has ~4,100+ lines in router/main.py alone, plus many scripts and
test files. Likely candidates for docstring additions:

  • router/main.py — most endpoints, helpers, and route handlers
  • router/agy_proxy.py — proxy functions
  • router/circuit_breaker.py — breaker logic
  • scripts/ — benchmark, verification, and utility scripts

Suggested Approach

  • Tackle incrementally: one module per PR
  • Prioritize public-facing functions and FastAPI route handlers
  • Use Google-style docstrings consistent with existing code

Labels

  • documentation
  • code-quality
  • maintenance

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    code-qualityCode quality improvementdocumentationImprovements or additions to documentationjulesIssues for JulesmaintenanceMaintenance and tech debt

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions