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

Update pool methods with docs and elegant syntax #1353

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

complexsum
Copy link

No description provided.

Update documentation of __init__ method of ThreadedPoolConnection.
The old documentation was incorrect because it says "initialze a
threading lock."
Updated methods of the ThreadedConnectionPool class to
use the elegant context manager syntax.
@complexsum complexsum changed the title Pool Update pool methods with docs and elegant syntax Sep 21, 2021
@dvarrazzo
Copy link
Member

What is the need of the elaborate docstring if it doesn't affect the docs at https://www.psycopg.org/docs/pool.html ?

@complexsum
Copy link
Author

@dvarrazzo I didn't knew about that but still it's good to have the docs updated in the code itself :)

@dvarrazzo
Copy link
Member

It is unneeded repetition IMO, unless you format that docstring in Sphinx and have the docs autogenerated from it.

Are you interested in this change? If not I will reject this as it is.

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