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

Updating deprecated docstring Client() class #3426

Merged
merged 2 commits into from
Nov 29, 2024

Conversation

Danarvelini
Copy link
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.
@tomchristie tomchristie merged commit 15e21e9 into encode:master Nov 29, 2024
5 checks passed
@tomchristie
Copy link
Member

Thanks.

@Danarvelini
Copy link
Contributor Author

Great, thank you :)

@Danarvelini Danarvelini deleted the patch-1 branch November 29, 2024 11:30
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