update the link guidance now that we suppress them automatically#1762
Open
nedbat wants to merge 4 commits intopython:mainfrom
Open
update the link guidance now that we suppress them automatically#1762nedbat wants to merge 4 commits intopython:mainfrom
nedbat wants to merge 4 commits intopython:mainfrom
Conversation
Documentation build overview
Show files changed (4 files in total): 📝 4 modified | ➕ 0 added | ➖ 0 deleted
|
nedbat
force-pushed
the
nedbat/link-update
branch
from
7daa59f to
1e248aa
Compare
hugovk
reviewed
Mar 9, 2026
documentation/style-guide.rst
Outdated
Comment on lines
+196
to
+201
| We use the `linklint Sphinx extension`__ to suppress two kinds of excessive | ||
| links: references in a section to itself and duplicate references in a | ||
| paragraph. Previously, editors had to carefully use an exclamation mark in a | ||
| Sphinx reference (``:func:`!map```) to prevent such links. | ||
|
|
||
| __ https://pypi.org/project/linklint/ |
Member
There was a problem hiding this comment.
I think we could move this para to the end of this section (just before the "Affirmative tone" header)?
So we lead with do/don't advice for the writer, and end with info about what the Sphinx extension does automatically.
Member
Author
There was a problem hiding this comment.
I didn't want to tell writers to use explicit suppression and then later say it was done automatically. I've adjusted the paragraph a bit.
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
nedbat
force-pushed
the
nedbat/link-update
branch
from
8631762 to
d5817ce
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.