docs: convert ordered lists to bullets across src/ and docs/src/ - #421
Merged
Merged
Conversation
DocumenterVitepress mis-renders ordered lists — 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). src/Solutions/build_solution.jl (2 trajectory-data-format items, each with a nested sub-list — outer marker only changes, nested markers and indentation stay, re-anchored under the new "- " width) and src/Building/name_validation.jl (5-point validation check). docs/src/getting-started.md and docs/src/index.md (1 list each, 2 and 4 items) — hand-written prose, never previously swept. Marker-only change, no prose edits. Not build-verified here: this repo's docs build currently fails for an unrelated, pre-existing reason — `UndefVarError: MakieBackend not defined in CTBase.Plotting` on docs/src/serialization/plotting.md:83-85 (`Makie.plot(sol)`), nothing to do with ordered lists. Verified by source grep instead (`grep -rn '^[0-9]+\. ' src/ docs/src/` -> empty) and by the identical pattern holding clean, build-confirmed, on the other four repos in this sweep (CTBase, CTSolvers, CTFlows.jl, OptimalControl). Companion PRs open in parallel on OptimalControl, CTBase, CTSolvers and CTFlows.jl. Full plan: control-toolbox/OptimalControl.jl .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 — valid1. 2. 3.comes out as<ol start="3">, the first item absorbed as unstyled prose. LuxDL/DocumenterVitepress.jl#150, open, no fix.Marker-only change (
1.→-), no prose edits.src/— 2 filesSolutions/build_solution.jl(2 trajectory-data-format items, each with a nested sub-list — outer marker only changes, nested markers and indentation stay, re-anchored under the new-width) andBuilding/name_validation.jl(5-point validation check).docs/src/— 2 filesgetting-started.mdandindex.md(1 list each, 2 and 4 items) — hand-written prose, never previously swept.Not build-verified here
This repo's docs build currently fails for an unrelated, pre-existing reason:
Nothing to do with ordered lists — confirmed identical on two separate rebuild attempts, before and after this change, so this PR introduces no new failure. Verified instead by source grep (
grep -rn '^[0-9]+\. ' src/ docs/src/→ empty) and by the identical fix pattern holding clean, build-confirmed, on the other four repos in this sweep (CTBase, CTSolvers, CTFlows.jl, OptimalControl). TheMakieBackendfailure is worth its own separate look — not investigated here, out of scope for this change.Context
Companion PRs open in parallel on OptimalControl, CTBase, CTSolvers and CTFlows.jl. Full plan and inventory:
control-toolbox/OptimalControl.jl→.reports/campaign/M-ordered-list-sweep.md.🤖 Generated with Claude Code