GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Docs: Bump sphinx-lint and fix unbalanced inline literal markup by hugovk · Pull Request #98441 · python/cpython

Conversation

@hugovk

@hugovk hugovk commented Oct 19, 2022

Copy link
Copy Markdown
Member

Bump sphinx-lint and fix its new finding:

$ make -C Doc check
# Check the docs and NEWS files with sphinx-lint.
# Ignore the tools and venv dirs and check that the default role is not used.
PATH=./venv/bin:$PATH sphinx-lint -i tools -i ./venv --enable default-role
No problems found.
PATH=./venv/bin:$PATH sphinx-lint --enable default-role ../Misc/NEWS.d/next/
../Misc/NEWS.d/next/C API/2022-07-12-17-39-32.gh-issue-94731.9CPJNU.rst:3: found an unbalanced inline literal markup. (unbalanced-inline-literals-delimiters)
../Misc/NEWS.d/next/C API/2022-07-12-17-39-32.gh-issue-94731.9CPJNU.rst:3: found an unbalanced inline literal markup. (unbalanced-inline-literals-delimiters)
make: *** [check] Error 1

Before

image

https://docs.python.org/3.12/whatsnew/changelog.html#c-api

After

image

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@hugovk
Bump sphinx-lint and fix unbalanced inline literal markup
28ee0f2
@bedevere-bot bedevere-bot added the awaiting review label Oct 19, 2022
@hugovk hugovk added skip issue skip news needs backport to 3.11 only security fixes labels Oct 19, 2022
@hugovk
hugovk requested a review from ezio-melotti October 19, 2022 11:24
ezio-melotti
ezio-melotti approved these changes Oct 19, 2022
View reviewed changes
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting review labels Oct 19, 2022
@ezio-melotti
ezio-melotti merged commit 5055300 into python:main Oct 19, 2022
@bedevere-bot bedevere-bot removed the awaiting merge label Oct 19, 2022
@miss-islington

miss-islington commented Oct 19, 2022

Copy link
Copy Markdown
Contributor

Thanks @hugovk for the PR, and @ezio-melotti for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@miss-islington

miss-islington commented Oct 19, 2022

Copy link
Copy Markdown
Contributor

Sorry, @hugovk and @ezio-melotti, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 50553004fe12dcaed3aa9a96b356eb84f247c8fd 3.11

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@miss-islington miss-islington assigned ezio-melotti Oct 19, 2022
@ezio-melotti

ezio-melotti commented Oct 19, 2022

Copy link
Copy Markdown
Member

@hugovk can you take care of the backport?
(I'm traveling with no PC for the next ~24h)

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk
hugovk deleted the docs-fix-sphinx-lint branch October 19, 2022 13:25
@hugovk

hugovk commented Oct 19, 2022

Copy link
Copy Markdown
Member Author

Yes, will do!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk hugovk mentioned this pull request Oct 19, 2022
[3.11] Docs: Bump sphinx-lint and use double backticks for inline literals (GH-98441) #98445
Merged
@bedevere-bot

bedevere-bot commented Oct 19, 2022

Copy link
Copy Markdown

GH-98445 is a backport of this pull request to the 3.11 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 19, 2022
ezio-melotti pushed a commit that referenced this pull request Oct 20, 2022
@hugovk
[3.11] Docs: Bump sphinx-lint and use double backticks for inline lit…
095e06f
…erals (GH-98441) (#98445)

Bump sphinx-lint and use double backticks for inline literals
@ezio-melotti

ezio-melotti commented Oct 20, 2022

Copy link
Copy Markdown
Member

Backport merged, thanks!

hugovk reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

carljm added a commit to carljm/cpython that referenced this pull request Oct 20, 2022
@carljm
Merge branch 'main' into typewatch
8bba5da
* main: (40 commits)
  pythongh-98461: Fix source location in comprehensions bytecode (pythonGH-98464)
  pythongh-98421: Clean Up PyObject_Print (pythonGH-98422)
  pythongh-98360: multiprocessing now spawns children on Windows with correct argv[0] in virtual environments (pythonGH-98462)
  CODEOWNERS: Become a typing code owner (python#98480)
  [doc] Improve logging cookbook example. (pythonGH-98481)
  Add more tkinter.Canvas tests (pythonGH-98475)
  pythongh-95023: Added os.setns and os.unshare functions (python#95046)
  pythonGH-98363: Presize the list for batched() (pythonGH-98419)
  pythongh-98374: Suppress ImportError for invalid query for help() command. (pythongh-98450)
  typing tests: `_overload_dummy` raises `NotImplementedError`, not `RuntimeError` (python#98351)
  pythongh-98354: Add unicode check for 'name' attribute in _imp_create_builtin (pythonGH-98412)
  pythongh-98257: Make _PyEval_SetTrace() reentrant (python#98258)
  pythongh-98414: py.exe launcher does not use defaults for -V:company/ option (pythonGH-98460)
  pythongh-98417: Store int_max_str_digits on the Interpreter State (pythonGH-98418)
  Doc: Remove title text from internal links (python#98409)
  [doc] Refresh the venv introduction documentation, and correct the statement about VIRTUAL_ENV (pythonGH-98350)
  Docs: Bump sphinx-lint and fix unbalanced inline literal markup (python#98441)
  pythongh-92886: Replace assertion statements in `handlers.BaseHandler` to support running with optimizations (`-O`) (pythonGH-93231)
  pythongh-92886: Fix tests that fail when running with optimizations (`-O`) in `_test_multiprocessing.py` (pythonGH-93233)
  pythongh-92886: Fix tests that fail when running with optimizations (`-O`) in `test_py_compile.py` (pythonGH-93235)
  ...
@JulienPalard JulienPalard mentioned this pull request Oct 31, 2022
Doc: Fix sphinx-lint issues introduced right before the last sphinx-lint version bump. #98911
Merged
JulienPalard added a commit that referenced this pull request Oct 31, 2022
@JulienPalard
Doc: Fix sphinx-lint issues (GH-98911)
c1c3be0
They were introduced right between GH-98441 and GH-98408.
@miss-islington miss-islington mentioned this pull request Oct 31, 2022
[3.11] Doc: Fix sphinx-lint issues (GH-98911) #98912
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 31, 2022
@JulienPalard @miss-islington
Doc: Fix sphinx-lint issues (pythonGH-98911)
0b94f75
They were introduced right between pythonGH-98441 and pythonGH-98408.
(cherry picked from commit c1c3be0)

Co-authored-by: Julien Palard <[email protected]>
miss-islington added a commit that referenced this pull request Oct 31, 2022
@miss-islington @JulienPalard
Doc: Fix sphinx-lint issues (GH-98911)
43cbb3d
They were introduced right between GH-98441 and GH-98408.
(cherry picked from commit c1c3be0)

Co-authored-by: Julien Palard <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ezio-melotti ezio-melotti ezio-melotti approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@ezio-melotti ezio-melotti

Labels

skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@hugovk @miss-islington @ezio-melotti @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.