Fix dead docs link in OptimizationProblem docstring#1395
Merged
ChrisRackauckas merged 1 commit intoJun 23, 2026
Merged
Conversation
The `OptimizationProblem` docstring linked to `docs.sciml.ai/Optimization/dev/optimization_packages/optimization`, which does not exist (returns a non-200 / 403). Repoint it to the Sophia package page at `optimization_packages/sophia/`, which is the actual page hosting the `Sophia` data-handling example referenced in the text. Because Optimization.jl renders SciMLBase docstrings (`modules=[..., SciMLBase, ...]`), this dead link is the remaining `:linkcheck` failure in SciML/Optimization.jl#1232. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude Opus 4.8 (1M context) <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
2 participants
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.
Summary
The
OptimizationProblemdocstring insrc/problems/optimization_problems.jllinked to a docs path that no longer exists:https://docs.sciml.ai/Optimization/dev/optimization_packages/optimization→ 403 / dead (there is no such page; the directory hosts per-package pages likesophia/).This repoints the dead link to the page that actually hosts the
Sophiadata-handling example referenced in the surrounding text:https://docs.sciml.ai/Optimization/dev/optimization_packages/sophia/→ HTTP 200The sibling mini-batching link (
tutorials/minibatch/→ 200) was already correct and is left unchanged.Why this matters
Optimization.jl renders SciMLBase docstrings (
modules=[..., SciMLBase, ...]), so this dead link surfaces in Optimization.jl's docs build. It is the only remaining:linkcheckfailure in SciML/Optimization.jl#1232 after that PR's other docs fixes.Verification
Documenter linkcheck-style curl (
curl -sI --proto =http,https -g -A '<chrome UA>' --max-time 10):Note on propagation
A SciMLBase release must be tagged and propagate (so Optimization.jl's docs pick up the new docstring) before Optimization.jl#1232's docs CI goes green. This PR is the necessary upstream prerequisite.
Please ignore until reviewed by @ChrisRackauckas.
🤖 Generated with Claude Code