Docs: improve class references linking in functions.rst#150891
Open
m-aciek wants to merge 1 commit into
Open
Conversation
With Linklint we link only first reference in a paragraph. Explicitly leave only reference which is expected to link. In dict, frozendict, frozenset and set reference docs.
Documentation build overview
|
Member
|
As I read these paragraphs, I wonder what value these sentences actually add:
About linklint: it's an interesting idea to preserve links in "See ..." sentences. I wonder if it is reliable enough, and if there are other sentence structures to consider. Also, what about translations? |
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
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.
With Linklint we link only first reference in a paragraph. Explicitly leave only reference which is expected to link.
In dict, frozendict, frozenset and set reference docs.
Before:
After: