docs(api) Link API reference first mentions#558
Merged
Conversation
why: API reference pages should let their first prose mention carry its Sphinx role target instead of introducing module names as plain literals in headings. what: - Remove module literal suffixes from public API headings - Retitle internal CLI module pages around their command role - Keep generated reference directives and prose links unchanged
why: The body introduction should point readers at the rendered class reference when it explains the internal path-redaction helper. what: - Link the PrivatePath explanatory intro with a class role - Leave later literal mentions and code examples unchanged
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #558 +/- ##
=======================================
Coverage 83.80% 83.80%
=======================================
Files 30 30
Lines 4389 4389
Branches 881 881
=======================================
Hits 3678 3678
Misses 471 471
Partials 240 240 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
why: The aggregate CLI reference rendered the same generated example anchors as the individual command pages, leaving the docs build with duplicate-label warnings. what: - Suppress the generated examples on the aggregate CLI reference - Keep per-command pages as the canonical example anchors
why: The legacy completion snippets are shell startup file contents, so they should read as exact file lines rather than loosely spaced interactive commands. what: - Remove blank lines from bash and zsh startup snippets - Keep shell-specific fences for startup file contents
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
{mod}prose instead of plain heading literals.PrivatePathexplanatory body introduction with its{class}target.Verification
rm -rf docs/_build; uv run ruff check . --fix --show-fixes; uv run ruff format .; uv run mypy .; uv run py.test --reruns 0 -vvv; just build-docs;Notes: the docs build exits 0 and continues to report the pre-existing duplicate-label warnings under
docs/cli.