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

Python version not clear if only for 3.6 or for every version inclusively before or after 3.6 for aiohttp docs. #11898

Closed
WillFM opened this issue Nov 21, 2024 · 2 comments

Comments

@WillFM
Copy link

WillFM commented Nov 21, 2024

SDK

Python SDK

Description

On https://docs.sentry.io/platforms/python/integrations/aiohttp/

it says:

If you're on Python 3.6, you also need the aiocontextvars package:

This is unclear, if it means specifically just Python 3.6, or everything also before or after Python 3.6

Suggested Solution

Add some clarifying verbiage. explicitly calling out if it specifically Python 3.6.

examples:

If you're on Python 3.6 specifically, you also need the aiocontextvars package:

If you're on Python 3.6 or earlier, you also need the aiocontextvars package:

If you're on Python 3.6 or later, you also need the aiocontextvars package:

@getsantry
Copy link
Contributor

getsantry bot commented Nov 21, 2024

Assigning to @getsentry/support for routing ⏲️

@szokeasaurusrex
Copy link
Member

szokeasaurusrex commented Nov 25, 2024

Hi @WillFM, thanks for the feedback. The callout is only for Python 3.6.

Adding the word "specifically" is redundant, since no other version numbers are listed in that sentence. If a piece of information were to apply to multiple Python versions, we would write something like "Version X.Y and later," "Version X.Y and earlier," "From version X.Y to version W.Z," or "Versions X.Y and W.Z." If we say something about "Version X.Y," you can safely assume that whatever we are talking about specifically refers to only version X.Y.

Also, Python 3.6 is the oldest Python version that the Sentry SDK supports, so in this case, writing "Python 3.6 or earlier" would not make any sense.

I am going to close this issue, since I don't think we need to make any changes to the docs here. Please let us know if you are still confused about anything though; we are happy to help clarify anything you are confused about!

@szokeasaurusrex szokeasaurusrex closed this as not planned Won't fix, can't repro, duplicate, stale Nov 25, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Archived in project
Development

No branches or pull requests

2 participants