Skip to content

Docs: Fix backtick errors found by sphinx-lint - #97998

Merged
ambv merged 4 commits into
python:mainfrom
hugovk:fix-sphinx-lint
Oct 7, 2022
Merged

Docs: Fix backtick errors found by sphinx-lint#97998
ambv merged 4 commits into
python:mainfrom
hugovk:fix-sphinx-lint

Conversation

@hugovk

@hugovkhugovk commented Oct 6, 2022

Copy link
Copy Markdown
Member

No description provided.

@hugovkhugovk added skip issue skip news docs Documentation in the Doc dir labels Oct 6, 2022
ezio-melotti
ezio-melotti reviewed Oct 6, 2022
View reviewed changes
Comment threadDoc/howto/logging.rst Outdated
Comment threadDoc/library/concurrent.futures.rst Outdated
Comment threadDoc/library/concurrent.futures.rst Outdated
Comment threadDoc/library/dis.rst Outdated
Comment threadDoc/library/hashlib.rst Outdated
hugovk
hugovk commented Oct 6, 2022
View reviewed changes

@hugovkhugovk left a comment •
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Use ... for True/False/None

Edit: oops, this was meant to be the review commit message! The buttons are next to each other... Will try again!

hugovkand others added 2 commits October 7, 2022 02:07
@hugovk@ezio-melotti
Use ... for True/False/None
96f26d4
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@hugovk@ezio-melotti
Make formatting consistent
192432d
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@ambv
ambv merged commit fa2d43e into python:mainOct 7, 2022
@hugovk
hugovk deleted the fix-sphinx-lint branch October 7, 2022 01:02
@CAM-Gerlach

CAM-Gerlach commented Oct 7, 2022

Copy link
Copy Markdown
Member

I can manually backport the changes (minus the Sphinx-lint for 3.10) since they do fix genuine defects and will avoid future merge conflicts when backporting other PRs, and can follow up later with a PR bumping 3.11 and 3.12 to the latest version of Sphinx-Lint (0.6.5, at this writing, which fixes an additional false positive found in the CPython docs that this PR worked around).

@ezio-melotti

ezio-melotti commented Oct 7, 2022

Copy link
Copy Markdown
Member

SGTM. Coordinate on Discord/IRL so that we don't step on each other's toes, and feel free to @mention me on issues/PRs.

@CAM-Gerlach

CAM-Gerlach commented Oct 7, 2022

Copy link
Copy Markdown
Member

Yup, talked to @hugovk about it—was sitting right next to him IRL yesterday and made sure we didn't duplicate each others' work on the various issues that came up 👍

carljm added a commit to carljm/cpython that referenced this pull request Oct 8, 2022
@carljm
Merge branch 'main' into typewatch
0de5aff
* main:
pythongh-86298: Ensure that __loader__ and __spec__.loader agree in warnings.warn_explicit() (pythonGH-97803)
pythongh-82874: Convert remaining importlib format uses to f-str. (python#98005)
Docs: Fix backtick errors found by sphinx-lint (python#97998)
pythongh-97850: Remove deprecated functions from `importlib.utils` (python#97898)
Remove extra spaces in custom openSSL documentation. (python#93568)
pythonGH-90985: Revert "Deprecate passing a message into cancel()" (python#97999)
mpage pushed a commit to mpage/cpython that referenced this pull request Oct 11, 2022
@hugovk@ezio-melotti@mpage
Docs: Fix backtick errors found by sphinx-lint (python#97998)
bd03a34
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@CAM-GerlachCAM-Gerlach mentioned this pull request Oct 17, 2022
Merged
CAM-Gerlach pushed a commit to CAM-Gerlach/cpython that referenced this pull request Oct 17, 2022
@hugovk@CAM-Gerlach
[3.11] Docs: Fix backtick errors found by sphinx-lint (pythonGH-97998)
a6ea2cc
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@CAM-GerlachCAM-Gerlach mentioned this pull request Oct 17, 2022
Merged
@bedevere-bot

bedevere-bot commented Oct 17, 2022

Copy link
Copy Markdown

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

CAM-Gerlach pushed a commit to CAM-Gerlach/cpython that referenced this pull request Oct 17, 2022
@hugovk@CAM-Gerlach
[3.10] Docs: Fix backtick errors found by sphinx-lint (pythonGH-97998)
b12e449
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@CAM-GerlachCAM-Gerlach mentioned this pull request Oct 17, 2022
Merged
@bedevere-bot

bedevere-bot commented Oct 17, 2022

Copy link
Copy Markdown

GH-98373 is a backport of this pull request to the 3.10 branch.

ezio-melotti pushed a commit that referenced this pull request Oct 17, 2022
@CAM-Gerlach@hugovk
[3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98371
ea19c28
)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
ezio-melotti pushed a commit that referenced this pull request Oct 17, 2022
@CAM-Gerlach@hugovk
[3.10] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98373
b2db1c2
)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@CAM-Gerlach@hugovk@pablogsal
[3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98371
f1ca2f6
)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ezio-melottiezio-melottiezio-melotti left review comments

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip issueskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@hugovk@CAM-Gerlach@ezio-melotti@bedevere-bot@ambv