Fix/improve documentation for users #188
Merged
Commits on Sep 14, 2024
-
Update robust_covariance docstring
Improve documentation auto-generated in API docs
-
Add module documentation for containers
I found working with the provided containers to be difficult, so I added a bit of extra documentation that will hopefully help other users
-
Update abstract_price_data_provider docstring
Add notes on implementing a data-provider, as I found the documentation to be lacking on expected return values and discovered them manually through permutation
Commits on Sep 23, 2024
-
-
Revert "Resolve Flake8 issues in new doc changes"
This reverts commit 23fe791.
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.