Major refactor based on Julia Discourse feedback #25
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.
This PR is a major refactor, based on the feedback at this Julia Discourse thread as of November 2023.
There are really too many changes to itemize and I recommend interested parties peruse the new documentation, which is less bloated and substantially rationalised. These changes will not be considered "final", even after merge.
The main change is a move away from methods with return multiple values (such as separate
report
orstate
) and towards the design suggested by @CameronBieganek. A basic user workflow looks like this:I am also handling the previously "optional data interface" in a different way. See the
obs
method referred to in the docs.I have not renamed
algorithms
tostrategies
in this PR. This was simply going to be too much cognitive dissonanceFor later PR's