docs: convert two ordered lists to bullets (phase M) - #936
Merged
Conversation
DocumenterVitepress mis-renders ordered lists from docstrings — valid 1./2./3. source comes out as <ol start="3">, the first item absorbed as unstyled prose (LuxDL/DocumenterVitepress.jl#150, open, no fix). Confirmed on the built site: docs/build/1/api/internals.html and solving.html both showed this. Both lists live in this package's own src/, so this fix needs no release or compat bump — src/solve/dispatch.jl's 3-step dispatch workflow and src/helpers/component_completion.jl's 4-step completion workflow both become bullets. This is the OptimalControl leg of a five-repo sweep — the same bug recurs in CTBase, CTSolvers, CTModels.jl and CTFlows.jl docstrings (transcluded here via the api/* pages) and, once checked, in three of those repos' own hand-written docs/src/ guide pages too. Full plan: .reports/campaign/M-ordered-list-sweep.md. Co-Authored-By: Claude Opus 5 <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.
What
DocumenterVitepressmis-renders ordered lists sourced from docstrings — valid1. 2. 3.comes out as<ol start="3">, the first item absorbed as unstyled prose glued onto the preceding paragraph. LuxDL/DocumenterVitepress.jl#150, open, no fix.Confirmed on the built site before this change:
docs/build/1/api/internals.htmlanddocs/build/1/api/solving.htmlboth showed the mis-render.Fixes the two lists that live in this package's own
src/— no release or compat bump needed:src/solve/dispatch.jl— the 3-step resolution-mode dispatch workflowsrc/helpers/component_completion.jl— the 4-step component-completion workflowMarker-only change (
1.→-), no prose edits.Context
This is the OptimalControl leg of a five-repo sweep. Phase E5 already fixed the two occurrences living directly in
docs/src/(guided tour,flows/overview.md); this closes the remainder. The same bug recurs in CTBase, CTSolvers, CTModels.jl and CTFlows.jl — both in their docstrings (transcluded here viaapi/*.md) and, once checked, in three of those repos' own hand-writtendocs/src/guide pages too. Companion PRs open in parallel on all four.Full plan and the complete 32-item inventory:
.reports/campaign/M-ordered-list-sweep.md.Note:
api/options.mdandapi/qualified.mdwill keep showing this bug on this site until CTBase and CTSolvers release the fix and this package's[compat]is raised to reach it (both are registry-resolved dependencies) — tracked as Stage 3 of the same plan, not part of this PR.Verified
docs/build/1/api/internals.htmlanddocs/build/1/api/solving.html: 0<ol start=occurrences (was 1 each).@ref/errors unchanged from baseline.🤖 Generated with Claude Code