Skip to content

Docs: Bump sphinx-lint and fix unbalanced inline literal markup - #98441

Merged
ezio-melotti merged 1 commit into
python:mainfrom
hugovk:docs-fix-sphinx-lint
Oct 19, 2022
Merged

Docs: Bump sphinx-lint and fix unbalanced inline literal markup#98441
ezio-melotti merged 1 commit into
python:mainfrom
hugovk:docs-fix-sphinx-lint

Conversation

@hugovk

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-roleNo 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

@miss-islington

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!

@miss-islington

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

@ezio-melotti

Copy link
Copy Markdown
Member

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

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

Copy link
Copy Markdown
MemberAuthor

Yes, will do!

@bedevere-bot

Copy link
Copy Markdown

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

@bedevere-botbedevere-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
…erals (GH-98441) (#98445)
Bump sphinx-lint and use double backticks for inline literals
@ezio-melotti

Copy link
Copy Markdown
Member

Backport merged, thanks!

carljm added a commit to carljm/cpython that referenced this pull request Oct 20, 2022
* 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 added a commit that referenced this pull request Oct 31, 2022
They were introduced right between GH-98441 and GH-98408.
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 31, 2022
They were introduced right between pythonGH-98441 and pythonGH-98408.
(cherry picked from commit c1c3be0)
Co-authored-by: Julien Palard <julien@palard.fr>
miss-islington added a commit that referenced this pull request Oct 31, 2022
They were introduced right between GH-98441 and GH-98408.
(cherry picked from commit c1c3be0)
Co-authored-by: Julien Palard <julien@palard.fr>
Sign up for freeto 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

@hugovk@miss-islington@ezio-melotti@bedevere-bot