docs: finish the coherence pass (guided tour residue + logo/abstract-syntax line width) - #934
Merged
Merged
Conversation
…olve.solve Phase E4 part 2 (#918) deferred getting-started/guided-tour.md to E5, and E5 (#920) made it execute without applying the coherence fixes. Close the gap at the Literate source: - wrap the six over-75 lines in `@example` blocks (constraint!, the two println, plot!, trim two long comments); - `solve(prob; …)` -> `NonlinearSolve.solve(prob; …)`, the last unqualified shooting call site (F25). Also the two files touched after the wrap pass: - examples/logo.md — four lines at 76-81 (circle, Axis, two padded comments), all brought within 75; - modelling/abstract-syntax.md — one 77-char comment trimmed. Verified: Literate regen of guided-tour.md has 0 lines over 75 in executable blocks; logo.md example blocks parse clean. Co-Authored-By: Claude Sonnet 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
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.
Follow-up to the E4 coherence pass (#917 / #918)
PR #918 (line wrapping, F16) explicitly deferred
getting-started/guided-tour.mdto Phase E5 because it is Literate-generated. Phase E5 (#920) made the tour execute but did not carry over the coherence-pass fixes, so two sub-items of the runbook's "coherence pass" step were left open. This closes them, plus two files that were touched after the wrap pass.docs/src-literate/guided-tour.jl(source;.md/.ipynb/.jlare regenerated at build, not tracked)@exampleblocks:constraint!(pre, :boundary; …), the twoprintln("Ipopt/MadNLP …"),plot!(plt_bang[1], …)wrapped one group per line with a trailing comma;has_abstract_definition,using OrdinaryDiffEqTsit5, and a##note).solve(prob; show_trace=Val(true))→NonlinearSolve.solve(prob; …). This was the last shooting call site still callingsolveunqualified afterusing NonlinearSolve; allexamples/*.mdandflows/shooting.mdwere already qualified.docs/src/examples/logo.mdFour lines at 76–81 characters (post-dating the #918 wrap pass):
circle(r) = […]andax = Axis(…)wrapped; two padded comments narrowed.docs/src/modelling/abstract-syntax.mdOne 77-character comment line in an
@exampleblock trimmed (77 → 62).Verification
Meta.parseallon the Literate source: OK.guided-tour.md: 0 lines over 75 in@example/@repl/@setupblocks (was 6).logo.md@exampleblocks: 5/5 parse clean.Deliberately not touched
The remaining over-75 lines in fenced blocks are all documented exceptions:
ERROR:/Hint/│ Contextboxes) ininstallation.md,save-load.md,flows/overview.md,migration.md— the exception PR docs: wrap over-long code lines (Phase E4 part 2, F16) #918 already recorded.migration.mdinertjuliafences carrying VitePress[!code error]/[!code warning]/[!code --]markers — introduced later by docs: VitePress code annotations + one mis-rendered list (Phase J) #922 (Phase J); the length comes from comment alignment and the end-of-line markers, not from a wrappable call.🤖 Generated with Claude Code