Add docstrings and update documentation #182
Merged
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.
Fix #144, fix #181
README.md
and add them as docstringsdocs/src/api.md
pageREADME.md
and put them in the proper section ofdocs/src/api.md
README.md
and turn them intodocs/src/tutorials.md
(no doctests yet)README.md
anddocs/src/reproducibility.md
intodocs/src/index.md
I didn't manage to update Documenter to v1.3 (it complained about the reproducibility part), so I'm leaving it for a later PR