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

New events + callbacks doc page #891

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

TorkelE
Copy link
Member

@TorkelE TorkelE commented May 30, 2024

New doc page for events and callbacks. Goes through the various types, and how to declare and use them. Also describes some common pitfuls one can encounter while working with these.

@TorkelE TorkelE mentioned this pull request May 30, 2024

Since continuous events (and callbacks) actively find the exact time point when they are triggered, supplying `tstops` is not required for these.

## [Programmatic creation of models containing events](@ref events_programmatic)
Copy link
Member Author

Choose a reason for hiding this comment

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

Right now, I start with going through how events work with the DSL. Then, at the end I have a separate section describing the details one needs to change when using a programmatic workflow (here and most other cases it is straightforward, except for the base syntax the two approaches are really similar).

nothing # hide
```

### [Callbacks during jump simulations](@id events_additional_considerations_jump_parameters)
Copy link
Member Author

Choose a reason for hiding this comment

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

This is handled properly for events, right? Not that the user can do anything if it isn't, but still.

@TorkelE TorkelE closed this May 31, 2024
@TorkelE TorkelE reopened this May 31, 2024
@TorkelE TorkelE changed the title New events + callbacks page [Ready] New events + callbacks page Jun 5, 2024
@TorkelE TorkelE changed the title [Ready] New events + callbacks page [Documentation - Ready] New events + callbacks doc page Jun 5, 2024
@TorkelE TorkelE changed the title [Documentation - Ready] New events + callbacks doc page [Non-urgent - Ready] New events + callbacks doc page Jun 11, 2024
@TorkelE TorkelE changed the title [Non-urgent - Ready] New events + callbacks doc page New events + callbacks doc page Jul 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant