From 58ae12d6a4508d1ec3f49271532f762dc6ccdd21 Mon Sep 17 00:00:00 2001 From: Olivier Cots Date: Tue, 1 Sep 2026 21:38:35 +0200 Subject: [PATCH] docs: convert two ordered lists to bullets (phase M) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit DocumenterVitepress mis-renders ordered lists from docstrings — valid 1./2./3. source comes out as
    , 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 --- src/helpers/component_completion.jl | 8 ++++---- src/solve/dispatch.jl | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/helpers/component_completion.jl b/src/helpers/component_completion.jl index 7ed5a0217..364b7944e 100644 --- a/src/helpers/component_completion.jl +++ b/src/helpers/component_completion.jl @@ -4,10 +4,10 @@ $(TYPEDSIGNATURES) Complete missing resolution components using the registry. This function orchestrates the component completion workflow: -1. Extract symbols from provided components using `_build_partial_description` -2. Complete the method description using `_complete_description` -3. Resolve method with parameter information using `CTBase.Orchestration.resolve_method` -4. Build or use strategies for each family using `_build_or_use_strategy` +- Extract symbols from provided components using `_build_partial_description` +- Complete the method description using `_complete_description` +- Resolve method with parameter information using `CTBase.Orchestration.resolve_method` +- Build or use strategies for each family using `_build_or_use_strategy` # Arguments - `discretizer::Union{CTSolvers.DOCP.AbstractDiscretizer, Nothing}`: Discretization strategy or `nothing` diff --git a/src/solve/dispatch.jl b/src/solve/dispatch.jl index f02bfcd8b..4dfe71fdb 100644 --- a/src/solve/dispatch.jl +++ b/src/solve/dispatch.jl @@ -4,9 +4,9 @@ $(TYPEDSIGNATURES) Main entry point for optimal control problem resolution. This function orchestrates the complete solve workflow by: -1. Detecting the resolution mode (explicit vs descriptive) from arguments -2. Extracting or creating the strategy registry for component completion -3. Dispatching to the appropriate Layer 2 solver based on the detected mode +- Detecting the resolution mode (explicit vs descriptive) from arguments +- Extracting or creating the strategy registry for component completion +- Dispatching to the appropriate Layer 2 solver based on the detected mode # Arguments - `ocp::CTModels.AbstractModel`: The optimal control problem to solve