Skip to content

Rename referrenced -> referenced, deprecate old spellings#257

Merged
Datseris merged 1 commit into
JuliaDynamics:mainfrom
oameye:finish-pr-236-referenced-rename
May 15, 2026
Merged

Rename referrenced -> referenced, deprecate old spellings#257
Datseris merged 1 commit into
JuliaDynamics:mainfrom
oameye:finish-pr-236-referenced-rename

Conversation

@oameye

@oameye oameye commented May 15, 2026

Copy link
Copy Markdown
Member

Finishes #236, applying @Datseris's review feedback.

  • Mass-rename referrenced -> referenced across src, tests, docs and CHANGELOG, including comments and error messages (also fixes the typos referrencing, referrence).
  • Export referenced_sciml_prob (previously unexported) and give it a docstring.
  • Add deprecations in src/deprecations.jl for the misspelled names so downstream code keeps working with a deprecation warning:
    • referrenced_sciml_prob -> referenced_sciml_prob
    • referrenced_sciml_model -> referenced_sciml_model
    • has_referrenced_model -> has_referenced_model (non-exported form)
  • Bump version 3.17.0 -> 3.18.0 and add a v3.18 changelog entry.

Closes #236.

Finishes JuliaDynamics#236 by following the maintainer's review:
- Mass-replace the misspelled `referrenced` with `referenced` across src,
  tests, docs and CHANGELOG, including comments and error messages.
- Export `referenced_sciml_prob` (previously unexported despite being part
  of the public extension API) and add a docstring.
- Keep `referrenced_sciml_prob`, `referrenced_sciml_model` and the internal
  `has_referrenced_model` as deprecated aliases in `src/deprecations.jl`,
  so downstream code keeps working with a deprecation warning.
- Bump version to 3.18.0 and add a changelog entry.
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 88.88889% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.50%. Comparing base (6c98239) to head (eaffccc).
⚠️ Report is 64 commits behind head on main.

Files with missing lines Patch % Lines
src/core/dynamicalsystem_interface.jl 83.33% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #257      +/-   ##
==========================================
+ Coverage   82.00%   83.50%   +1.49%     
==========================================
  Files          15       15              
  Lines         717      970     +253     
==========================================
+ Hits          588      810     +222     
- Misses        129      160      +31     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Datseris Datseris merged commit 567d298 into JuliaDynamics:main May 15, 2026
3 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