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 for incorrect rendering of > as ≥ in version constraints #36044

Merged

Conversation

trujillo-adam
Copy link
Contributor

Our docs platform automatically adds links to words at the beginning of a list item when the words are formatted with code backticks. And because links are automatically style with an underline, the < character becomes underlined, which changes the meaning. This PR changes the list of operators you can use to constrain versions into a table, which omits the autogenerated links.

I also made some content updates for compliance with our writing style guidelines.

Fixes #32423

Target Release

Backports for all versions going back to 1.1.

@trujillo-adam trujillo-adam added documentation 1.1-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.2-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.3-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.4-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.5-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.6-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.7-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.8-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.9-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.10-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged labels Nov 19, 2024
@trujillo-adam trujillo-adam marked this pull request as ready for review November 19, 2024 00:13
@trujillo-adam trujillo-adam requested review from a team as code owners November 19, 2024 00:13
Copy link
Contributor

The equivalence tests will be updated. Please verify the changes here.

@crw
Copy link
Contributor

crw commented Nov 19, 2024

Approved. That is a lot of backport merging! Do you need me to handle that?

@crw crw changed the title This PR fixes #32423 Fix for incorrect rendering of > as ≥ in version constraints Nov 19, 2024
@trujillo-adam
Copy link
Contributor Author

Approved. That is a lot of backport merging! Do you need me to handle that?

Nah dawg, I got it. Thanks.

@trujillo-adam trujillo-adam merged commit d11ae2c into main Nov 19, 2024
23 checks passed
@trujillo-adam trujillo-adam deleted the docs/update-version-constraints-operators-reference branch November 19, 2024 02:32
Copy link
Contributor

Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch.

trujillo-adam added a commit that referenced this pull request Nov 19, 2024
…nts-operators-reference

Fix for incorrect rendering of > as ≥ in version constraints

Fixed merge conflicts
trujillo-adam added a commit that referenced this pull request Nov 19, 2024
…nts-operators-reference

Fix for incorrect rendering of > as ≥ in version constraints

Fixed merge conflicts
@crw
Copy link
Contributor

crw commented Nov 19, 2024

That was a lot of merging, thank you very much!

trujillo-adam added a commit that referenced this pull request Nov 19, 2024
…nts-operators-reference

Fix for incorrect rendering of > as ≥ in version constraints
Fixed merge conflicts
trujillo-adam added a commit that referenced this pull request Nov 19, 2024
…nts-operators-reference

Fix for incorrect rendering of > as ≥ in version constraints
Fixed merge conflicts
trujillo-adam added a commit that referenced this pull request Nov 19, 2024
…nts-operators-reference

Fix for incorrect rendering of > as ≥ in version constraints
Fix merge conflicts
trujillo-adam added a commit that referenced this pull request Nov 19, 2024
…nts-operators-reference

Fix for incorrect rendering of > as ≥ in version constraints
Fixed merge conflicts
trujillo-adam added a commit that referenced this pull request Nov 19, 2024
…nts-operators-reference

Fix for incorrect rendering of > as ≥ in version constraints
Fixed merge conflicts
trujillo-adam added a commit that referenced this pull request Nov 19, 2024
…nts-operators-reference

Fix for incorrect rendering of > as ≥ in version constraints
Fixed merge conflicts
Copy link
Contributor

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1.1-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.2-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.3-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.4-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.5-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.6-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.7-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.8-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.9-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.10-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Linking in documentation leading to misread character
2 participants