Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix doc: correct models.Response.json() docstring #6529

Merged
merged 7 commits into from
Feb 13, 2025

Conversation

anupam-arista
Copy link
Contributor

@anupam-arista anupam-arista commented Sep 14, 2023

The method is doing json-decode of a response content(if any) to a python object, unlike what the docstring says..

@anupam-arista anupam-arista changed the title Update models.Response.json docstring clearer Update models.Response.json docstring to be clearer Sep 14, 2023
@achapkowski
Copy link

I know I'm not an admin, but this doc string change is a solid change could it be merged?

@anupam-arista anupam-arista changed the title Update models.Response.json docstring to be clearer Nit: Update models.Response.json() docstring to be clearer Dec 12, 2024
@anupam-arista anupam-arista changed the title Nit: Update models.Response.json() docstring to be clearer Nit: Update models.Response.json() docstring to be correct Dec 12, 2024
@anupam-arista anupam-arista changed the title Nit: Update models.Response.json() docstring to be correct Nit: correct models.Response.json() docstring Dec 12, 2024
@anupam-arista
Copy link
Contributor Author

anupam-arista commented Dec 12, 2024

I had spent like 1 hour because these 2 words were pointing the wrong way, so maintainers please consider this nit.

@anupam-arista anupam-arista changed the title Nit: correct models.Response.json() docstring fix doc: correct models.Response.json() docstring Feb 11, 2025
Co-authored-by: Ian Stapleton Cordasco <[email protected]>
Copy link
Contributor

@sigmavirus24 sigmavirus24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think my last suggestion forgot a new line

Co-authored-by: Ian Stapleton Cordasco <[email protected]>
@nateprewitt nateprewitt merged commit 1b7c37e into psf:main Feb 13, 2025
29 of 30 checks passed
@anupam-arista anupam-arista deleted the patch-1 branch February 18, 2025 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants