Document response classes #175
Merged
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
pquentin
commented
Jul 2, 2024
| @@ -36,6 +36,7 @@ | |||
| ] | |||
|
|
|||
| pygments_style = "sphinx" | |||
| pygments_dark_style = "monokai" | |||
There was a problem hiding this comment.
This is required to make sure code blocks such as the one in HttpHeaders are visible in dark mode.
Comment on lines
-47
to
+48
| "requests": ("https://docs.python-requests.org/en/master", None), | ||
| "requests": ("https://docs.python-requests.org/en/latest", None), |
There was a problem hiding this comment.
There is a redirection in place, but /latest is the correct place. It also avoids a message about this redirection.
Comment on lines
+193
to
+198
| :ivar int status: HTTP status code | ||
| :ivar str http_version: HTTP version being used | ||
| :ivar HttpHeaders headers: HTTP headers | ||
| :ivar float duration: Number of seconds from start of request to start of response | ||
| :ivar NodeConfig node: Node which handled the request | ||
| :ivar typing.Optional[str] mimetype: Mimetype to be used by the serializer to decode the raw response bytes. |
There was a problem hiding this comment.
I wasn't able to get Sphinx to show the #: comments, even with autodata, so I placed the information in the class docstring, using instance variables.
miguelgrinberg
approved these changes
Jul 2, 2024
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.
As part of answering to elastic/elasticsearch-py#2606, I wanted to use Intersphinx mappings so that return types like "ObjectApiResponse" in elasticsearch-py docs link to the transport docs. That way, users will be able to see that
response.meta.statusgives access to the status code. However, ObjectApiResponse is not in the Intersphinx data:This pull requests fixes that, and it can be verified with: