Collection docstrings #261
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
kyleknap
added
documentation
kyleknap
force-pushed
the
collection-docstrings
branch
from
64359bd to
ecb2125
Compare
jamesls
removed
blocked
pr/needs-review
kyleknap
force-pushed
the
collection-docstrings
branch
from
ecb2125 to
de0eb74
Compare
|
@jamesls Rebased. Good to look at now. |
kyleknap
added
the
pr/needs-review
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
So this is dependent on a bunch of pending PR's. So I would recommend looking at the botocore docstring PR's first and the action/identifier/attr/references/subresources boto3 docstring PR before looking at this one. Just wanted to put this PR out there.
This PR adds docstrings to collection methods:
all,filter,page_size,limitand added a docstring to the collection dangled off of a resource (i.e.s3.buckets)cc @jamesls @mtdowling @rayluo @JordonPhillips