Repository navigation
Fix docs build: update BVDAE tutorial to current Ascher API and fix SparseConnectivityTracer links - #919
Conversation
BoundaryValueDiffEqAscher >= 1.18 dropped the `zeta` solver keyword; side-condition points are now expressed by evaluating the solution inside the multi-point `bc` callback, matching the convention already used by the SecondOrderBVProblem example above it in this file. Also point the SparseConnectivityTracer links at the JuliaDiff organization, which now hosts the package and its docs; the old adrianhill.de docs URL 404s and fails linkcheck. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Devin <noreply@cognition.ai> Agent-Harness: Devin CLI 3000.11.92 Agent-Model: swe-2-high Agent-Session: local Devin job /home/crackauc/sandbox/goals/ci-green/devin-jobs/diffeqdocs-ascher (transcript in /home/crackauc/sandbox/goals/ci-green/devin-jobs/diffeqdocs-ascher/log.txt)
The rewritten BVDAE example only runs against Ascher >= 1.18: on 1.17 the callable-`bc!` form without `zeta` fails with a BoundsError inside the solver. The docs env compat previously admitted 1.15.3+. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Devin <noreply@cognition.ai> Agent-Harness: Devin CLI 3000.11.92 Agent-Model: swe-2-high Agent-Session: local Devin job /home/crackauc/sandbox/goals/ci-green/devin-jobs/diffeqdocs-ascher (transcript in /home/crackauc/sandbox/goals/ci-green/devin-jobs/diffeqdocs-ascher/log.txt)
Independent review (Codex CLI 0.164.0 / gpt-6.1-sol), session 01a1965f-36a7-7ff1-8e61-78d9309eee3a, reviewed head 9f60ce1
Review written by the reviewer named above in a session other than the PR author's, and copied here by the posting agent without change to its findings. The posting agent did not re-run the reviewer's commands. Summary: Updates the BVDAE tutorial to the callable boundary-condition API, requires Ascher 1.18, and repairs two SparseConnectivityTracer links. Independent execution reproduces the base failure and confirms the head example succeeds; no blocking defects were found. Blast radius: Documentation dependency resolution, the semi-explicit BVDAE tutorial example, and two external links; no library implementation or solver default changes. Evidence: Blind assessment frozen in INITIAL.md and INITIAL.sha256 before author context. The exact head example passed with Ascher 1.18.1 and AutoForwardDiff (exit 0); the merge-base example failed on its unsupported zeta keyword in the same environment (exit 1). Both replacement links returned HTTP 200 and the API anchor exists. Head formatting and spelling checks passed; Documentation was skipped because the PR is a draft. Blocking findingsNone. Non-blocking findingsNone. What I ran
What I did not verifyI did not build or deploy the full documentation site, resolve the full documentation dependency environment, test the exact Ascher 1.18.0 lower bound, or run other Julia versions/platforms. The standalone example does not execute earlier examples in the page's shared Documenter module. CPU ForwardDiff was exercised; no GPU, MPI, Reactant, or other AD backend was tested, and those implementations are unchanged. The PR's full documentation CI is skipped, so the author's claimed full-build success was not independently reproduced. 🤖 Posted by an AI agent — harness: Claude Code · model: claude-sonnet-5-5 |
Summary
The Documentation job on master fails with
makedocs encountered errors [:linkcheck, :example_block](job 117444520459):BoundaryValueDiffEqAscher>= 1.18 removed thezetaside-condition keyword from theAscherNsolvers (current signature:Ascher4(; nlsolve, optimize, jac_alg, platform, max_num_subintervals)). The BVDAE example is rewritten to the current API: multi-point boundary conditions are expressed by evaluating the solution insidebc!(res, u, p, t)(u(0.0)[1],u(1.0)[2], ...), the same convention theSecondOrderBVProblemexample above it already uses. The demonstrated conditions (x1(0)=0,x3(0)=1,x2(1)=sin(1)) and thejac_algargument are unchanged.adrianhill.de/SparseConnectivityTracer.jl/...(404). The package moved toJuliaDiffand its docs are now atjuliadiff.org; both SparseConnectivityTracer links inadvanced_ode_example.mdare updated accordingly.docs/Project.tomlnow requiresBoundaryValueDiffEqAscher = "1.18": the rewrittenbc!form only runs on Ascher >= 1.18 (on 1.17 it fails inside the solver with aBoundsError).Verification
julia --project=docs docs/make.jl(Julia 1.13.1; resolved versions identical to the failing CI run:BoundaryValueDiffEqAscher 1.18.1,BoundaryValueDiffEqCore 2.8.5,Documenter 1.19.0,SciMLBase 3.58.0).Before (master worktree):
After (this branch, exact committed tree):
After the compat bump:
Pkg.resolve()in the docs env succeeds and still selectsBoundaryValueDiffEqAscher 1.18.1, and the rewritten BVDAE block still runs (retcode: Success, boundary residuals ~1e-15).The rewritten example was also run standalone in the docs env:
retcode: Success,x1(0) ≈ 0,x3(0) ≈ 1,x2(1) = sin(1).typosand Runic--checkare clean on the changed files.Two intermediate
make.jlruns failed only on transientstatus: 429linkcheck responses fromgithub.com(rate limiting from repeated local linkcheck sweeps); all such URLs return 200 to curl, and the final run passed every check on the committed tree.Not verified
deploydocsis a no-op outside CI by design.UndefVarError: OrdinaryDiffEqCore not defined in OrdinaryDiffEqPRKlines are Debug-level noise from@refs inside OrdinaryDiffEqPRK's ownKuttaPRK2p5docstring (OrdinaryDiffEqPRK v2.4.0 importsOrdinaryDiffEqCoreselectively, so the module name isn't bound there; Documenter resolves the refs in another module). They do not fail the build and are not fixable from DiffEqDocs.Please ignore until reviewed by @ChrisRackauckas.
Risk assessment
docs/make.jlbuilt locally, fail-before (exit 1, same errors as CI) / pass-after (exit 0); rewritten example verified to satisfy the original boundary conditions; replacement links return 200🤖 Generated by an AI agent — harness: Devin CLI 3000.11.92 · model: swe-2-high
Conversation: local job diffeqdocs-ascher-devin (no session URL)