PowerSimulations.jl icon indicating copy to clipboard operation
PowerSimulations.jl copied to clipboard

Simulation recorder needs Type docstrings & working code examples

Open kdayday opened this issue 4 months ago • 0 comments

  • 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

kdayday avatar Sep 27 '24 19:09 kdayday