Skip to content

Conversation

oxinabox
Copy link

@oxinabox oxinabox commented Oct 1, 2025

Checklist

  • Appropriate tests were added
  • Any code changes were done in a way that does not break public API
  • x ] All documentation related to code changes were updated
  • The new code follows the
    contributor guidelines, in particular the SciML Style Guide and
    COLPRAC.
  • Any new documentation only uses public API
    ??? idk

Additional context

Closes #1325

@TorkelE
Copy link
Member

TorkelE commented Oct 1, 2025

Looks good. In practise the section probably doesn't really belong in the DSL bit. The best would probably be to list this and other relavant functions in the API after this: https://docs.sciml.ai/Catalyst/stable/api/core_api/#Basic-species-properties, and then we can link to it after where we introduce symbolic variables (e.g. here and here).

Not suggesting that you have to do it, happy to add it myself.

@oxinabox
Copy link
Author

oxinabox commented Oct 1, 2025

yeah i thought about putting it there but couldn't workout exactly where it fit neatly

@TorkelE
Copy link
Member

TorkelE commented Oct 1, 2025

yeah, the docs have grown a lot so it is quite hard to figure out, but now we have the text which is the important bit. I'll push changes to this PR and finish it of (if you are happy with that).

@oxinabox
Copy link
Author

oxinabox commented Oct 1, 2025

sounds good

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.

How to get the name of a species?
2 participants