Skip to content

Conversation

@ChrisRackauckas-Claude
Copy link

Summary

This PR fixes the markdown syntax errors in the "Parallel Ensemble Simulations Interface" documentation section that were making the documentation difficult to read, and adds missing documentation for the repeat parameter in prob_func.

Changes Made

  • Fixed markdown syntax errors: Changed incorrect docs to @docs syntax in the "Full Timeseries Statistics" section (lines 111 and 154)
  • Added missing closing backticks: Properly closed the @docs code block that was missing its closing backticks
  • Documented the repeat parameter: Added comprehensive documentation for the repeat parameter in the prob_func signature, explaining that it tracks iteration numbers for reruns when output_func returns rerun=true

Details

The issue reported that the documentation starting from the "Full Timeseries Statistics" section had markdown syntax errors making it hard to read. Upon investigation, I found:

  1. Two instances where docs was used instead of @docs in code blocks
  2. A missing closing backtick sequence for an @docs block
  3. The repeat parameter in prob_func was never explained in the documentation, even though it appears in all the examples

The repeat parameter documentation was added based on the comprehensive docstring in src/ensemble/ensemble_problems.jl which explains that repeat is the iteration of the repeat that starts at 1 and increments if rerun was true.

Test plan

  • Verified all markdown syntax errors are fixed
  • Confirmed the repeat parameter is now properly documented
  • Ensured documentation maintains consistency with existing style

Fixes #1141

🤖 Generated with Claude Code

- Fixed `docs` to `@docs` syntax in Full Timeseries Statistics section
- Added missing closing backticks for @docs block
- Added documentation for the `repeat` parameter in `prob_func` signature
- Clarifies that `repeat` tracks iteration number for reruns when `output_func` returns `rerun=true`

Fixes SciML#1141

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@ChrisRackauckas ChrisRackauckas merged commit 6f1a1d0 into SciML:master Sep 9, 2025
36 of 46 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.

Markdown errors in "Parallel Ensemble Simulations Interface" section of documentation

2 participants