docs: add missing module-level docstrings#373
Open
Blackgaurd wants to merge 1 commit into
Open
Conversation
add a short module docstring to the modules that had none (main.py, api/routes, db, utils, calendars, and the undocumented service/runtime modules) so per-module purpose lives in the code itself, complementing the co-located AGENTS.md files. no behavior change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
This was referenced Jul 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a short module-level docstring to the 22 backend modules that had none: `main.py`, `core/api/routes.py`, `core/db/`, `core/utils/`, `core/calendars/*` (interface, registry, utils, and the 4 definitions), and the previously-undocumented `core/service/{builder,catalog,models,locks}.py` and `core/runtime/{config,loader,registry,runner,validator}.py`.
Why
The "self-documenting code" half of the docs restructure: per-module purpose should live in the code itself, complementing the co-located `AGENTS.md` files. The complex `service/` and parts of `runtime/` already had rich module docstrings; this fills the gaps.
Benefit
Every backend module now states its purpose at the top. No behavior change.
Stacked on #372.