[CIVIS-1614] DOC specify response type in Returns documentation.

civisanalytics / civis-python

Civis API Python Client

BSD 3-Clause "New" or "Revised" License

34 stars 26 forks source link

[CIVIS-1614] DOC specify response type in Returns documentation. #438

Closed gkcivis closed 2 years ago

gkcivis commented 2 years ago

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.

gkcivis commented 2 years ago

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

gkcivis commented 2 years ago

I forgot to update the related test for the newest change to link the class and increase indentation.