Repository navigation
fix spelling, close issue #526 - #527
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Documentation still contains references to a non-existent Roots.Chandrupatlu symbol and a few fixable typos introduced in the edited lines.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR addresses Issue #526 by correcting the spelling of the Chandrupatla bracketing method name across the library, tests, and documentation, while keeping backward compatibility for the old misspelling.
Changes:
- Renames the public method type usage from
ChandrapatlatoChandrupatla(and updates tests/docs accordingly). - Updates the bracketing implementation file/include to the corrected filename and adds an alias for the old misspelling.
- Bumps patch version from
3.0.7to3.0.8.
File summaries
| File | Description |
|---|---|
| test/test_jet.jl | Updates method list to use Roots.Chandrupatla() |
| test/test_bracketing.jl | Updates bracketing method tuples to use Roots.Chandrupatla() |
| src/Roots.jl | Updates include to Bracketing/chandrupatlu.jl |
| src/Bracketing/chandrupatlu.jl | Renames method/state types and keeps Chandrapatla as an alias |
| Project.toml | Patch version bump to 3.0.8 |
| docs/src/roots.md | Updates tutorial text/examples to Chandrupatla |
| docs/src/refs.bib | Updates section heading spelling for the reference |
| docs/src/reference.md | Updates reference listing to Roots.Chandrupatla |
| docs/src/index.md | Updates method list in docs index (currently has a remaining incorrect symbol) |
| docs/src/geometry-zero-finding.md | Updates narrative example (currently has a remaining incorrect symbol) |
Review details
Suppressed comments (1)
src/Bracketing/chandrupatlu.jl:14
- Spelling in comment: “mis-spelling” should be “misspelling”.
- Files reviewed: 9/10 changed files
- Comments generated: 4
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #527 +/- ##
=======================================
Coverage 86.80% 86.80%
=======================================
Files 43 43
Lines 2697 2697
=======================================
Hits 2341 2341
Misses 356 356 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Fix spelling of method name. Close #526