fix(docs): /reference /backtest redirects + Google docstrings + typed options API (5ipk.5)#6
Merged
Merged
Conversation
…tions API (5ipk.5) Three doc-quality fixes closing the substantive 5ipk.5 remainder: - Add /reference/ and /backtest/ redirect stubs (both 404'd on the live site; the review flagged them). Match the existing native-page meta-refresh pattern: /reference/ → /api/, /backtest/ → /guides/backtest/. - Convert quantwave/polars.py docstrings from NumPy to Google style (the style every other module uses under mkdocstrings' docstring_style: google). The NumPy sections were mis-parsed as prose, so mkdocs_autorefs read doctest output like [0]/[24800.0] as cross-references — 8 warnings, now 0. - Add type annotations to the options-class methods (`_Col`/`_ColOrVal` aliases, `-> pl.Expr` returns) so griffe no longer warns about undocumented types, and the public options surface is now fully typed. Verified: mkdocs build --strict → 0 autorefs + 0 link warnings; doctests (11) and tests/options_india (42) pass. Not included (deferred, cosmetic): migrating the 162 native redirect stubs to the mkdocs-redirects plugin. mkdocs-redirects also emits meta-refresh HTML, so it's purely repo hygiene, and it would require the sync_indicator_docs.py generator to programmatically rewrite mkdocs.yml — not worth that risk. The stubs work and are generator-maintained. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Closes the substantive remainder of quantwave-5ipk.5.
Fixes
/reference/and/backtest/404s (review-flagged) → redirect stubs matching the existing native-page meta-refresh pattern (/reference/→/api/,/backtest/→/guides/backtest/).mkdocs_autorefswarnings → 0:quantwave/polars.pyused NumPy-style docstrings while mkdocstrings is configureddocstring_style: google(as every other module uses), so its doctest output ([0],[24800.0]) was misread as cross-references. Converted to Google style._Col/_ColOrValaliases and-> pl.Exprreturns to alloptionsmethods, clearing the griffe "no annotation" warnings and giving the flagship Options India surface full type coverage.Verification
mkdocs build --strict→ 0 autorefs, 0 link warningstests/options_india(42) passcheck_doc_links/check_doc_latex/check_doc_driftall greenDeferred (cosmetic, documented on the bead)
Migrating the 162 native redirect stubs to
mkdocs-redirects— that plugin also emits meta-refresh HTML (no functional gain) and would require thesync_indicator_docs.pygenerator to programmatically rewritemkdocs.yml. Not worth the risk; the stubs work and are generator-maintained.Docstring conversion + annotations done by a Sonnet subagent; orchestration + redirects + verification by the main agent.
🤖 Generated with Claude Code