Updated Incomplete/Incorrect Documentation #88
Merged
Conversation
This file contains 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
bushrat011899
force-pushed
the
DocumentationUpdates
branch
from
d38e7da
to
cb42a5f
Compare
|
Very good! I would be very grateful if you could also update some comments in the examples. The explanations are outdated now that snapshotting has been overhauled. |
|
Sure thing! |
bushrat011899
force-pushed
the
DocumentationUpdates
branch
from
cb42a5f
to
bd543d7
Compare
|
This is very important work to keep this repository useful for everyone! Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Objective
Some documentation is now out of date, incorrect, or was entirely missing. This should be updated before the next release.
Solution
Went through and fixed some documentation.
Notes
I don't see this as being particularly controversial, since it just adds some docstrings to public types/methods.