adjust docstrings for _iter_shard methods / functions
#3615
+39
−13
Conversation
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
github-actions
bot
added
the
needs release notes
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.
For all
_iter_shardmethods and functions there is a fallback to chunks when no shards are present, but this is not clear from either the name or the docstring. Though we can't quickly change the names, the docstrings could be more informative. In this PR I adjusted the docstrings.Note: based on discussion with @d-v-b chunks technically do not have keys, but because of the fallback when shards are not present these are currently returned. Broader discussion will be whether chunks should also return keys.
The current situation stems from the ambiguity in the meanings of 'shard' and 'chunk'.
TODO:
@joshmoore