[CIVIS-1614] DOC specify response type in Returns documentation. #438
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
| response_doc = doc_from_responses(responses) | ||
| elements = split_method_params(params) | ||
| _, _, _, query_params, _ = elements | ||
| is_iterable = iterable_method(verb, query_params) |
There was a problem hiding this comment.
So glad that the codebase already has this handy iterable_method function!
gkcivis
changed the title
|
Added change to CHANGELOG.md; made Jackson's recommended changes to add link to response class and indenting response attributes by one level. Converting to formal PR |
|
I forgot to update the related test for the newest change to link the class and increase indentation. |
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.
Ticket: https://civisanalytics.atlassian.net/browse/CIVIS-1614
These changes are to specify the civis response type (regular vs paginated) in https://civis-python.readthedocs.io/en/v1.15.1/api_resources.html
TODO: update CHANGELOG, if this implementation is good.