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

Fix wrong operator spacing in docs #11052

Closed
wants to merge 1 commit into from

Conversation

ezio-melotti
Copy link

DESCRIBE YOUR PR

I noticed what appeared to be a double space after the = in the example at https://docs.sentry.io/platforms/python/migration/1.x-to-2.x#scope-configuring
Upon further inspection, this turned out to be an extra padding that was introduced in:

The passing was supposed to only apply to the +/- at the beginning of a diff line, but it's actually applied to all operators.

This PR attempts to apply the the change only to the +/- by using a more specific CSS selector.

I'm not sure I got the syntax right though, and there is no CI that builds the doc on forks, so I'm opening a draft PR here to test. The idea is that the +/- are the first children in a span with class diff-inserted or diff-deleted.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

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

Copy link

vercel bot commented Aug 11, 2024

@ezio-melotti is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Aug 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 12, 2024 7:29am

@chargome
Copy link
Member

@ezio-melotti nice catch, thanks for the pr. I just ran a preview deployment and will merge if everything looks fine

@chargome
Copy link
Member

Hey @ezio-melotti, the change you made didn't quite fix the issue since it broken indentation again. I created a follow-up pr in #11054

@chargome chargome closed this Aug 12, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Aug 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants