adding some more info for ScanIndexForward #691
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
I added some more information to the scan_index_forward parameter from my experiments with sorting on the range key, and the documentation I felt missed this infromation.
|
Here is the documentation I referred to, and figured out it was a boolean. |
ikonst
reviewed
Oct 2, 2019
| @@ -574,8 +574,9 @@ def query(cls, | |||
| :param consistent_read: If True, a consistent read is performed | |||
| :param index_name: If set, then this index is used | |||
| :param limit: Used to limit the number of results returned | |||
| :param scan_index_forward: If set, then used to specify the same parameter to the DynamoDB API. | |||
| Controls descending or ascending results | |||
| :param scan_index_forward: (boolean) If set, then used to specify the same parameter to the DynamoDB API. | |||
There was a problem hiding this comment.
Suggested change
| :param scan_index_forward: (boolean) If set, then used to specify the same parameter to the DynamoDB API. | |
| :param scan_index_forward: If set, then used to specify the same parameter to the DynamoDB API. |
to be consistent with other documentation. We already have typing in the typeshed.
There was a problem hiding this comment.
Or maybe simply:
:param scan_index_forward: If False, the sort order will be descending on the range key. The default sort order is ascending.
I don't think saying it's "the same parameter to the DynamoDB API" is very helpful, since it can be said about most of our features, since we're just wrapping DynamoDB and trying not remain relatively transparent.
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.
No description provided.