Documentation improvements: Fix typos, grammar, and outdated references #1446
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
- Fix typo "moe" -> "more" in ParameterEstimation benchmarks - Fix abbreviation "Apprx." -> "Approx." in Bio benchmarks - Improve grammar and clarity in ParameterEstimation files: * Fix comma splice and sentence structure * Correct subject-verb agreement (tolerance/tolerances) * Improve comparative form (worse -> worst) * Remove double spaces and improve punctuation - Improve clarity in BayesianInference file (chaotic behavior description) - Make print statements more professional in AstroChem file - Remove outdated Julia 1.0 version references in StiffODE files Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This PR improves documentation quality across multiple benchmark files.
Changes Made
Typos Fixed
ParameterEstimation/LotkaVolterraParameterEstimation.jmdandParameterEstimation/FitzHughNagumoParameterEstimation.jmdegfr_net.jmd,fceri_gamma2.jmd,multisite2.jmd,multistate.jmd,BCR.jmd)Grammar and Clarity Improvements
ParameterEstimation/LotkaVolterraParameterEstimation.jmd:BayesianInference/DiffEqBayesLorenz.jmd: replaced informal phrasing "goes awry" with clearer technical languageCode Quality
AstroChem/astrochem.jmd:Outdated References
VanDerPol.jmd,ROBER.jmd,Hires.jmd,Pollution.jmd,Orego.jmd) - Julia 1.0 is from 2018, making these references no longer relevantFiles Changed
14 files across 5 benchmark categories
All changes are focused on improving documentation quality without altering any code functionality or benchmark results.
cc: @ChrisRackauckas