-
-
Notifications
You must be signed in to change notification settings - Fork 224
Document and export continuous_events
and discrete_events
#2567
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
Conversation
continuous_events
and discrete_events
Seems reasonable to me. Add it to the docs? |
docs/src/basics/Events.md
Outdated
@@ -221,6 +225,10 @@ equations can either all change unknowns (i.e. variables) or all change | |||
parameters, but one cannot currently mix unknown variable and parameter changes within one | |||
individual event. | |||
|
|||
Given an `AbstractSystem`, one can fetch its discrete events, and the discrete events of any |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add it to the system docs for the docstrings of the available functions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh, I see, I missed that section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should I remove the mention of it from Events.md
and just have it in the system docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes
Done, let me know if that's a sufficient level of detail. I'm not sure how much we should explain the structure of |
That would be good to add. Looks like formatter is blocking tests. |
Odd docs build failure, I'm going to assume that was a freak event, but also do a pass over this repo soon to fix a few red checkmarks. |
Checklist
contributor guidelines, in particular the SciML Style Guide and
COLPRAC.
Additional context
I'd like a blessed API for fetching the callbacks of an ODESystem without reaching into internals, so I figure marking these functions as exported and giving them docstrings would be a good way to go about this. If there's a better, existing way to do that please let me know.