Repository navigation
Add DynamicTols and Defaults submodules to library documentation - #506
Merged
Merged
Conversation
Contributor
|
After the build completes, the updated documentation will be available here |
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The library documentation currently only includes autodocs for the main
MPSKitmodule, but not for any of its submodules such asMPSKit.DynamicTolsandMPSKit.Defaults. I think it would be better to add these submodules to the library docs, since they definitely contain useful docstrings. For example, I personally wanted to refer toMPSKit.DyamicTols.DynamicTolfrom another project, but now alsoMPSKit.Defaults.set_buffering!is referred to from the manual docs but the docstring itself is not available.