Merged
Conversation
Add comprehensive docstrings to all public functions, settings, and constants so mkdocstrings generates useful output. Restructure api.md with intro text, per-section descriptions, reordered sections (views first), explicit member lists to hide private internals, and a hand-written URL table. Add global `!^_` filter in mkdocs.yml. Made-with: Cursor
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.
Summary
checks.py,views.py,utils.py,settings.py,constants.py, anddecorators.pyso mkdocstrings generates useful outputdocs/reference/api.mdwith an intro paragraph, per-section descriptions, reordered sections (views first, internals last), explicit member lists to hide private functions, andshow_source: falsefor views/decoratorswatchman.urlsauto-generated section with a hand-written URL pattern table with cross-links to views!^_private-member filter and adjustheading_levelinmkdocs.ymlTest plan
mkdocs build --strictpasses with zero warningsMade with Cursor