docs: Rename python configuration options and add deprecation alerts #7432
Conversation
|
@mgaligniana is attempting to deploy a commit to the Sentry Team on Vercel. A member of the Team first needs to authorize it. |
| @@ -379,6 +396,12 @@ The number of characters after which the values containing text in the event pay | |||
|
|
|||
| <ConfigKey name="with-locals" supported={["python"]}> | |||
There was a problem hiding this comment.
I noticed this option will also be deprecated: https://github.com/getsentry/sentry-python/blob/master/sentry_sdk/client.py#L82C20-L82C20 so I added an alert here too!
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Thanks for adding the change to the docs! Looks good to me text-wise, what I think we can improve on a bit is the organization.
Right now the config key list is a mixture of deprecated and supported options. There's a #### Deprecated heading a bit further down the page, we should move the request-bodies and with-locals there. I'd also remove the description for those and just leave the deprecation note there with the link to the new config option.
mgaligniana
force-pushed
the
sentry_python_ticket_2247
branch
2 times, most recently
from
caa9ccd
to
2996ec1
Compare
|
I moved the two options to the bottom and added the "deprecated" header (I removed the text because I think is "repetitive", what do you think?) -> in the PR description I updated an image how it looks now! And I updated the diff too! I realized Thank you! |
Looks great!
Nicely spotted :) Yes, that makes sense. Looks good to me, handing this over to our docs team. |
|
@mgaligniana Just noticed we reference |
|
Ohh, good catch! Sure! |
Rename `request_bodies` to `max_request_body_size` and add deprecation alert. Add deprecation alert also for `with_locals`.
mgaligniana
force-pushed
the
sentry_python_ticket_2247
branch
from
2996ec1
to
c5758a0
Compare
…7432) Rename `request_bodies` to `max_request_body_size` and add deprecation alert. Add deprecation alert also for `with_locals`.
Rename
request_bodiestomax_request_body_sizeand add deprecation alert.Add deprecation alert also for
with_locals.Pre-merge checklist
Description of changes
This PR adds the documentation for the changes made in getsentry/sentry-python#2247 for ticket getsentry/sentry-python#926.
A preview of how it looks like:
Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
Extra resources