-
Notifications
You must be signed in to change notification settings - Fork 243
Closed
Copy link
Labels
choreLinting, formatting, dependency hygiene, or project maintenance choresLinting, formatting, dependency hygiene, or project maintenance chorescicdIssue with CI/CD process (GitHub Actions, scaffolding)Issue with CI/CD process (GitHub Actions, scaffolding)devopsDevOps activities (containers, automation, deployment, makefiles, etc)DevOps activities (containers, automation, deployment, makefiles, etc)triageIssues / Features awaiting triageIssues / Features awaiting triage
Milestone
Description
✅ [CHORE]: Achieve 100% docstring coverage
Summary
Increase docstring coverage from 96.3% to 100% by adding missing docstrings to 30 functions/methods.
Requirements
- All docstrings must use Google docstring format
- Include *Examples- sections with doctests where applicable
- Must pass
make pydocstyle
- Existing tests must continue to pass:
make pylint test doctest flake8
✅ Checklist of missing docstrings (30 total)
config.py
-
Settings._parse_allowed_origins()
-
Settings._parse_federation_peers()
main.py
-
validation_exception_handler()
-
database_exception_handler()
schemas.py
-
GatewayRead._populate_auth()
translate.py
-
_PubSub.__init__()
-
StdIOEndpoint.__init__()
-
_build_fastapi.get_sse.event_gen()
-
_run_stdio_to_sse._shutdown()
-
_run_sse_to_stdio.read_stdout()
-
_run_sse_to_stdio.pump_sse_to_stdio()
alembic/env.py
- (module-level docstring)
alembic/versions/b77ca9d2de7e_uuid_pk_and_slug_refactor.py
-
_use_batch()
-
upgrade()
-
downgrade()
cache/session_registry.py
-
SessionRegistry.add_session._db_add()
-
SessionRegistry.get_session._db_check()
-
SessionRegistry.remove_session._db_remove()
-
SessionRegistry.broadcast._db_add()
-
SessionRegistry.respond._db_read_session()
-
SessionRegistry.respond._db_read()
-
SessionRegistry.respond._db_remove()
-
SessionRegistry.respond.message_check_loop()
-
SessionRegistry._db_cleanup_task._db_cleanup()
-
SessionRegistry._db_cleanup_task._refresh_session()
services/server_service.py
-
ServerNameConflictError.__init__()
-
ServerService.__init__()
utils/create_jwt_token.py
-
_parse_args()
-
_payload_from_cli()
-
main()
✅ Validation checklist
-
make interrogate
shows 100% -
make pydocstyle
passes -> separate issue -
make pylint test doctest flake8
passes
Metadata
Metadata
Assignees
Labels
choreLinting, formatting, dependency hygiene, or project maintenance choresLinting, formatting, dependency hygiene, or project maintenance chorescicdIssue with CI/CD process (GitHub Actions, scaffolding)Issue with CI/CD process (GitHub Actions, scaffolding)devopsDevOps activities (containers, automation, deployment, makefiles, etc)DevOps activities (containers, automation, deployment, makefiles, etc)triageIssues / Features awaiting triageIssues / Features awaiting triage