Skip to content

Conversation

@ChrisRackauckas-Claude
Copy link

Summary

This PR fixes several documentation issues to improve accuracy and consistency:

  • Fixed typo: "Google Collab" → "Google Colab"
  • Fixed typo: "tolernace" → "tolerance"
  • Fixed critical bug: DDE example had constant_lags incorrectly assigned tspan value instead of constant_lags variable (affected both README.md and vignettes/dde.Rmd)
  • Fixed inconsistencies: Changed list() to c() for tspan in vignettes (ode.Rmd, sde.Rmd) to match README and proper R vector syntax
  • Standardized pipe operators: Updated %>% to |> (native R 4.1+ pipe) in dae.Rmd and dde.Rmd for consistency with README
  • Added missing code: Included the interpolation example sol$.(0.2) in ode.Rmd that was referenced but not shown

Test plan

  • Reviewed all changes for accuracy
  • Verified syntax corrections match R best practices
  • Confirmed consistency between README and vignettes
  • Validated that the DDE bug fix uses correct variable assignment

Files changed

  • README.md: Fixed typos and DDE bug
  • vignettes/ode.Rmd: Added missing code example, fixed tspan syntax
  • vignettes/sde.Rmd: Fixed tspan syntax
  • vignettes/dde.Rmd: Fixed critical bug and pipe operator
  • vignettes/dae.Rmd: Standardized pipe operator

@ChrisRackauckas - These are practical documentation improvements that fix bugs and inconsistencies.

🤖 Generated with Claude Code

- Fix typo: "Google Collab" → "Google Colab"
- Fix typo: "tolernace" → "tolerance"
- Fix critical bug in DDE example: constant_lags was incorrectly assigned tspan value
- Fix tspan inconsistencies: Changed list() to c() in vignettes (ode.Rmd, sde.Rmd)
- Standardize pipe operators: Updated %>% to |> (native R 4.1+ pipe) in dae.Rmd and dde.Rmd
- Add missing interpolation code example in ode.Rmd (sol$.(0.2))

These changes improve documentation accuracy and consistency across README and vignettes.

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
@ChrisRackauckas ChrisRackauckas merged commit e9ba6b5 into SciML:master Jan 8, 2026
1 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants