Skip to content

Updating deprecated docstring Client() class#3426

Merged
lovelydinosaur merged 2 commits intoencode:masterfrom
Danarvelini:patch-1
Nov 29, 2024
Merged

Updating deprecated docstring Client() class#3426
lovelydinosaur merged 2 commits intoencode:masterfrom
Danarvelini:patch-1

Conversation

@Danarvelini
Copy link
Copy Markdown
Contributor

@Danarvelini Danarvelini commented Nov 29, 2024

Summary

Updating deprecated docstring Client() class. Keyword param "proxies" is no longer used and supported, but it was still "optional" by the docstring of the class. That docstring is now updated to avoid developers on passing deprecated params.

Checklist

  • I understand that this PR may be closed in case there was no previous discussion. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.

Update _client.py

"proxies" param is missing if passed as keyword argument.
Even tough it should be there, since it is mentioned in the docstring as an optional param.
Update _client.py

Updating deprecated docstring Client() class. Keyword param "proxies" is no longer used, but it was still "possible" by the docstring of the class. That docstring is now updated to avoid developers on passing deprecated params.
@lovelydinosaur lovelydinosaur merged commit 15e21e9 into encode:master Nov 29, 2024
@lovelydinosaur
Copy link
Copy Markdown
Contributor

Thanks.

@Danarvelini
Copy link
Copy Markdown
Contributor Author

Great, thank you :)

@Danarvelini Danarvelini deleted the patch-1 branch November 29, 2024 11:30
samclearman pushed a commit to titanmsp/httpx that referenced this pull request Apr 26, 2025
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.

2 participants