Fix markdown syntax errors and document repeat parameter in Ensembles.md #1143
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
repeatparameter inprob_func.Changes Made
docsto@docssyntax in the "Full Timeseries Statistics" section (lines 111 and 154)@docscode block that was missing its closing backticksrepeatparameter: Added comprehensive documentation for therepeatparameter in theprob_funcsignature, explaining that it tracks iteration numbers for reruns whenoutput_funcreturnsrerun=trueDetails
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:
docswas used instead of@docsin code blocks@docsblockrepeatparameter inprob_funcwas never explained in the documentation, even though it appears in all the examplesThe
repeatparameter documentation was added based on the comprehensive docstring insrc/ensemble/ensemble_problems.jlwhich explains thatrepeatis the iteration of the repeat that starts at 1 and increments ifrerunwas true.Test plan
repeatparameter is now properly documentedFixes #1141
🤖 Generated with Claude Code