Skip to content

Export referenced_sciml_prob with correct spelling#236

Closed
reykboerner wants to merge 1 commit into
JuliaDynamics:mainfrom
reykboerner:referenced
Closed

Export referenced_sciml_prob with correct spelling#236
reykboerner wants to merge 1 commit into
JuliaDynamics:mainfrom
reykboerner:referenced

Conversation

@reykboerner

Copy link
Copy Markdown
Contributor

We are using referrenced_sciml_prob downstream but it is currently neither exported nor declared public. Also, it would be nice to switch to a correct spelling of referenced. Maybe this can be solved with an alias for now and then the old spelling can become deprecated in the future?

@Datseris Datseris left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Version bump is missing
  • Correct spelling should be the spelling used everywhere with a mass replace. The wrong spelling should be the deprecation and it should be in the file deprecated.jl at top-level (if it doens't exist we make one now).

"""
referrenced_sciml_prob(ds::Dynamical system)

Return `ds.integ.sol.prob` if there is a referenced model.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should say what it returns instead of the field that it returns. Internal fields are not public.

# Simply extend the `referrenced_sciml_prob` and you have symbolic indexing support!
import SymbolicIndexingInterface
"""
referrenced_sciml_prob(ds::Dynamical system)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
referrenced_sciml_prob(ds::Dynamical system)
referrenced_sciml_prob(ds::DynamicalSystem)

@oameye

oameye commented May 1, 2026

Copy link
Copy Markdown
Member

@reykboerner bump

@oameye

oameye commented May 14, 2026

Copy link
Copy Markdown
Member

@reykboerner Shall I finish this?

@reykboerner

Copy link
Copy Markdown
Contributor Author

Sure, would be great @oameye

Datseris pushed a commit that referenced this pull request May 15, 2026
Finishes #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.
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