docs: phase 6 â mkdocstrings API reference (final docs phase)#10
Merged
Conversation
docs/reference/api.md, with mkdocstrings directives covering every public name re-exported from yarlpattern/__init__.py — tiered by audience: * Primary API — URLPattern, URLPatternResult, COMPONENTS * Escape helpers — escape_pattern_string, escape_regexp_string * Low-level building blocks (tokenizer / parts / regex generation) — for tools that compose URLPatterns programmatically Auto-extracted from the existing Google-style docstrings. Future API changes to docstrings ship to the site on the next push to main with zero hand-maintained reference content to drift. properdocs nav gains a Reference > API entry between WPT Conformance and Comparisons. Phase 6 task #48 closed. With Phase 6 merged the documentation arc is complete: Overview (URLPattern-101 + ecosystem) Examples (11 verified worked examples) Reference (auto-extracted API) Comparisons (vs aiohttp UrlDispatcher, vs yarl) Explanation (architecture) WPT Conformance (auto-generated)
github-actions
Bot
added
the
documentation
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
Final docs phase.
docs/reference/api.mdwithmkdocstringsdirectives covering every public name re-exported fromyarlpattern/__init__.py, tiered by audience:URLPattern,URLPatternResult,COMPONENTSescape_pattern_string,escape_regexp_stringAuto-extracted from existing Google-style docstrings. Future API changes ship to the site on the next push to main with zero hand-maintained reference content to drift.
properdocs.ymlnav gains aReference > APIentry between WPT Conformance and Comparisons.With this merged, the documentation arc is complete
/overview/what-is-urlpattern/,/overview/ecosystem-adoption//examples/.../reference/api//comparisons/aiohttp/,/comparisons/yarl//explanation/architecture//wpt-compliance/Test plan
just docs --strictclean — mkdocstrings rendered every directive without warningjust lintall 11 tools pass/overview/pages/reference/api/