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

Run sphinx-lint on Misc/NEWS.d/next/ #108212

Merged
merged 4 commits into from
Aug 21, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Aug 21, 2023

Follow on from #105750.

Before that PR, we used to run sphinx-lint on Doc/ and Misc/NEWS.d/next/

After, we only ran sphinx-lint on Doc/. I think leaving out Misc/NEWS.d/next/ was an oversight on my part, let's add it back.

In the meantime, a handful of NEWS warnings had slipped through, this PR also fixes them.

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Although I do not see a difference in some files. Why are they marked as different?

@hugovk
Copy link
Member Author

hugovk commented Aug 21, 2023

They were "No newline at end of file":

Misc/NEWS.d/next/Library/2023-07-14-16-54-13.gh-issue-106752.BT1Yxw.rst:1: found an unbalanced inline literal markup. (unbalanced-inline-literals-delimiters)
Misc/NEWS.d/next/Library/2023-07-14-16-54-13.gh-issue-106752.BT1Yxw.rst:1: default role used (hint: for inline literals, use double backticks) (default-role)
Misc/NEWS.d/next/Library/2020-05-03-00-33-15.bpo-18319.faPTlx.rst:1: default role used (hint: for inline literals, use double backticks) (default-role)
Misc/NEWS.d/next/Library/2020-05-03-00-33-15.bpo-18319.faPTlx.rst:2: default role used (hint: for inline literals, use double backticks) (default-role)
Misc/NEWS.d/next/Core and Builtins/2023-06-24-10-34-27.gh-issue-105775.OqjoGV.rst:1: No newline at end of file. (missing-final-newline)
Misc/NEWS.d/next/Library/2023-08-17-14-45-25.gh-issue-105736.NJsH7r.rst:2: default role used (hint: for inline literals, use double backticks) (default-role)
Misc/NEWS.d/next/Library/2023-08-17-14-45-25.gh-issue-105736.NJsH7r.rst:3: default role used (hint: for inline literals, use double backticks) (default-role)
Misc/NEWS.d/next/Core and Builtins/2023-07-04-04-50-14.gh-issue-100288.yNQ1ez.rst:3: default role used (hint: for inline literals, use double backticks) (default-role)
Misc/NEWS.d/next/Library/2023-06-30-16-42-44.gh-issue-106263.tk-t93.rst:2: No newline at end of file. (missing-final-newline)
Misc/NEWS.d/next/Build/2023-07-28-18-17-33.gh-issue-106881.U3Ezdq.rst:1: default role used (hint: for inline literals, use double backticks) (default-role)
Misc/NEWS.d/next/Core and Builtins/2023-07-27-11-47-29.gh-issue-104432.oGHF-z.rst:2: default role used (hint: for inline literals, use double backticks) (default-role)
Misc/NEWS.d/next/Library/2023-08-07-14-12-07.gh-issue-107715.238r2f.rst:1: default role used (hint: for inline literals, use double backticks) (default-role)
Misc/NEWS.d/next/Library/2023-07-16-10-40-34.gh-issue-106789.NvyE3C.rst:1: role use a single backtick, double backtick found. (role-with-double-backticks)
Misc/NEWS.d/next/Library/2023-07-16-10-40-34.gh-issue-106789.NvyE3C.rst:1: role use a single backtick, double backtick found. (role-with-double-backticks)
Misc/NEWS.d/next/Library/2023-06-25-12-28-55.gh-issue-106075.W7tMRb.rst:1: default role used (hint: for inline literals, use double backticks) (default-role)
Misc/NEWS.d/next/Core and Builtins/2023-07-27-11-18-04.gh-issue-106078.WEy2Yn.rst:1: No newline at end of file. (missing-final-newline)
Misc/NEWS.d/next/Library/2023-07-22-21-57-34.gh-issue-107089.Dnget2.rst:2: No newline at end of file. (missing-final-newline)

https://github.com/hugovk/cpython/actions/runs/5925848833/job/16066091943

@hugovk hugovk removed the needs backport to 3.12 bug and security fixes label Aug 21, 2023
@hugovk
Copy link
Member Author

hugovk commented Aug 21, 2023

The 3.12 backport will only need the first commit, I'll backport it manually.

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, a few optional suggestions:

hugovk and others added 2 commits August 21, 2023 15:22
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk hugovk enabled auto-merge (squash) August 21, 2023 12:23
@bedevere-bot
Copy link

GH-108213 is a backport of this pull request to the 3.12 branch.

@hugovk hugovk merged commit 71962e5 into python:main Aug 21, 2023
21 of 22 checks passed
@hugovk hugovk deleted the pre-commit-sphinx-lint-news branch August 21, 2023 13:13
@bedevere-bot
Copy link

There's a new commit after the PR has been approved.

@serhiy-storchaka, @AlexWaygood: please review the changes made to this pull request.

Yhg1s pushed a commit that referenced this pull request Aug 21, 2023
Yhg1s added a commit to Yhg1s/cpython that referenced this pull request Aug 21, 2023
Yhg1s added a commit that referenced this pull request Aug 21, 2023
Fix lint warnings in Misc/NEWS.d/next/Library/2023-08-17-14-45-25.gh-issue-105736.NJsH7r.rst
(effectively a backport of GH-108212).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants