Reattach the TestItemController docstring - #64
Merged
Conversation
`const DEFAULT_SHUTDOWN_GRACE_SECONDS` was added between the docstring and the
struct it documents, so the docstring attached to the const instead and
`TestItemController` ended up with none. `deploy-docs` has been failing on main
ever since:
no docs found for 'TestItemControllers.TestItemController' in `@docs` block
Cannot resolve @ref for md"[`TestItemController`](@ref)"
Moving the const above the docstring puts the docstring back next to the struct.
Verified by building the docs locally: `makedocs` now renders instead of
terminating on :docs_block and :cross_references.
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.
deploy-docshas been failing on main and on every open PR:const DEFAULT_SHUTDOWN_GRACE_SECONDS = 30.0was added between the docstring and the struct it documents, so the docstring attached to the const andTestItemController— the package's main entry point — ended up with none.Moving the const above the docstring puts the docstring back next to the struct. No other change.
Verified by building the docs locally:
makedocsnow gets all the way throughRenderDocument/HTMLWriterinstead of terminating on:docs_blockand:cross_references. The remaining "134 docstrings not included in the manual" message is a pre-existing warning, not an error.Merging this turns
deploy-docsgreen on main and on #61, #62 and #63 at once.🤖 Generated with Claude Code