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

Simulation recorder needs Type docstrings & working code examples #1149

Closed
kdayday opened this issue Sep 27, 2024 · 1 comment
Closed

Simulation recorder needs Type docstrings & working code examples #1149

kdayday opened this issue Sep 27, 2024 · 1 comment

Comments

@kdayday
Copy link
Contributor

kdayday commented Sep 27, 2024

  • Recorder event types, such as SimulationStepEvent, in "recorder_events.jl" need docstrings.
  • Specific recorder event types are referenced in the Simulation Recorder page, and need hyperlinks to new docstrings
  • Simulation Recorder examples should be updated with working @example or @repl blocks instead of copy-pasted julia blocks
  • Current julia blocks are causing formatter to fail. I am adding an ignore for "simulation_recorder.md" which should be removed once it is updated
@kennedy-mindermann
Copy link

moved this to be part of #1165

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants