Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more documentation #2871

Merged
merged 1 commit into from
Jul 17, 2024

Conversation

hersle
Copy link
Contributor

@hersle hersle commented Jul 17, 2024

It's not a lot, but it's something.
Appreciate it if you read through and suggest any changes!
Some of it is intended to close #1822.

Checklist

  • Appropriate tests were added
  • Any code changes were done in a way that does not break public API
  • 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

@ChrisRackauckas
Copy link
Member

Looks all good to me. I think we need to add these docstrings to the docs as well, but that doesn't necessarily need to be in this one.

One of the big issues with the ModelingToolkit docs is that you used to only be allowed to use a docstring in one place. So generate_jacobian could only be on one page. But now there's a primary location feature in documenter. So we could have the primary location be some abstractsystem page, but then also have the ODESystem be complete with all of the functions that work on an ODESystem.

@ChrisRackauckas ChrisRackauckas merged commit c723155 into SciML:master Jul 17, 2024
21 of 22 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.

Documentation for equations, equations, full_equations
2 participants