Documentation improvements: Fix function naming and API usage #2965
Conversation
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
This commit improves the documentation quality with the following changes: 1. **Fix function naming conventions in usage.md**: - Changed `lorenz` to `lorenz!` to follow Julia's in-place function convention - Changed `HH_acceleration` to `HH_acceleration!` for consistency - Updated corresponding ODEProblem calls 2. **Update deprecated keyword argument**: - Changed `vars` to `idxs` in plot() call to use current API 3. **Improve docs/make.jl path handling**: - Added logic to handle running from both repo root and docs directory - Prevents "no such file or directory" errors when building docs These changes ensure documentation examples follow best practices and work correctly with the current OrdinaryDiffEq.jl API. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
ranocha
reviewed
Jan 1, 2026
docs/make.jl
Outdated
Comment on lines
3
to
7
| # Handle both running from repo root and from docs directory | ||
| manifest_src = isfile("./docs/Manifest.toml") ? "./docs/Manifest.toml" : "Manifest.toml" | ||
| project_src = isfile("./docs/Project.toml") ? "./docs/Project.toml" : "Project.toml" | ||
| manifest_dst = isfile("./docs/src/assets/Manifest.toml") || isdir("./docs/src/assets") ? "./docs/src/assets/Manifest.toml" : "src/assets/Manifest.toml" | ||
| project_dst = isfile("./docs/src/assets/Project.toml") || isdir("./docs/src/assets") ? "./docs/src/assets/Project.toml" : "src/assets/Project.toml" |
Member
There was a problem hiding this comment.
Wouldn't it be better to use @__DIR__, e.g., joinpath(@__DIR__, "Manifest.toml")?
Member
There was a problem hiding this comment.
It would yes, just did this change in another repo. I'll add it to its prompt because I think the cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true) is in every repo so as this goes around it should do the same change everywhere.
Contributor
Author
There was a problem hiding this comment.
Good suggestion! Updated to use joinpath(@__DIR__, ...) which is much cleaner and more robust. Thanks for the review!
Address review feedback from @ranocha: Use joinpath(@__DIR__, ...) instead of complex path detection logic. This is simpler and more robust since @__DIR__ always returns the directory containing the current file. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
ranocha
approved these changes
Jan 2, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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
This PR improves the documentation quality with focused corrections to code examples:
lorenz!,HH_acceleration!)varskeyword toidxsin plotting examplesdocs/make.jlrobustness to handle execution from both repo root and docs directorySpecific Changes
docs/src/usage.md
lorenz→lorenz!andHH_acceleration→HH_acceleration!to follow Julia convention for in-place functions that mutate their first argumentplot(sol, vars = (1, 2, 3))toplot(sol, idxs = (1, 2, 3))to use current Plots.jl APIODEProblemandSecondOrderODEProblemdocs/make.jl
Testing
cc: @ChrisRackauckas
🤖 Generated with Claude Code