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

bpo-33421: Add AsyncContextManager to typing module documentation. #6700

Closed
wants to merge 1 commit into from

Conversation

@travigd
Copy link
Contributor

travigd commented May 3, 2018

@the-knights-who-say-ni

This comment has been minimized.

Copy link

the-knights-who-say-ni commented May 3, 2018

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

When your account is ready, please add a comment in this pull request
and a Python core developer will remove the CLA not signed label
to make the bot check again.

Thanks again to your contribution and we look forward to looking at it!

Copy link
Contributor

ilevkivskyi left a comment

LGTM. Thank you for adding this!

@ilevkivskyi

This comment has been minimized.

Copy link
Contributor

ilevkivskyi commented May 14, 2018

Oh, wait. why are you making the PR to the 3.6 branch? It looks like this also needs to be added to 3.7 and master. Could you please close this one and re-open w.r.t. master branch? I will then merge and backport to other relevant branches (this is how things are normally done here).

@travigd

This comment has been minimized.

Copy link
Contributor Author

travigd commented May 14, 2018

Okay, I'll mention you in the new pull request.

@travigd travigd closed this May 14, 2018
@travigd travigd deleted the travigd:3.6 branch May 14, 2018
@travigd

This comment has been minimized.

Copy link
Contributor Author

travigd commented May 14, 2018

Actually, 3.7+ has contextlib.AbstractAsyncContextManager but 3.6 has no such equivalent. Should the documentation for 3.6 and 3.7 be different? The rest of the documentation tends to be along the lines of

   A generic version of ...

so for 3.7 we could say

A generic version of :class:`contextlib.AbstractAsyncContextManager`.

but not for 3.6.

In fact, seems 3.6 has some weird dodging around the absence of contextlib.AbstractAsyncContextManager.

@ilevkivskyi

This comment has been minimized.

Copy link
Contributor

ilevkivskyi commented May 14, 2018

It is OK to have different text for different versions. You can make two PRs, one against master with Generic version of ..., and one against 3.6 with something like An abstract class with __aenter__ and __aexit__ methods (you can just copy this from current docs in collections.abc).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.