8000 Simplify rst cross references by omitting the shortener ~ when not needed by timhoffm · Pull Request #10551 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Simplify rst cross references by omitting the shortener ~ when not needed #10551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Feb 21, 2018
Merged

Simplify rst cross references by omitting the shortener ~ when not needed #10551

merged 1 commit into from
Feb 21, 2018

Conversation

timhoffm
Copy link
Member

PR Summary

The use of the shortener character ~ is unneccesary for cases like `~.Axes`. ~ has no other function than limiting the display to the last component of the referenced entity.

This PR removes ~ from all references that have only one component anyway. It does not have any effect and leaving it out improves readability.

@timhoffm timhoffm changed the title Simply rst cross references by omitting the shortener ~ when not needed Simplify rst cross references by omitting the shortener ~ when not needed Feb 20, 2018
@timhoffm timhoffm force-pushed the simplify-rst-crossref branch from 62059ae to cfab638 Compare February 20, 2018 23:40
@timhoffm timhoffm force-pushed the simplify-rst-crossref branch from cfab638 to 0093fa6 Compare February 21, 2018 00:06
@tacaswell tacaswell added this to the v2.2.0 milestone Feb 21, 2018
tacaswell
tacaswell approved these changes Feb 21, 2018
View reviewed changes
Copy link
Member
@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

But will defer to @anntzer 's expertise on if this is the right rst thing to do.

@anntzer
Copy link
Contributor
anntzer commented Feb 21, 2018

Apparently I'm not the local expert anymore, but looks good :-) (for some reason I thought that without the ~ it would always render the fully qualified name)

@anntzer anntzer merged commit 0aad6fd into matplotlib:master Feb 21, 2018
lumberbot-app bot pushed a commit that referenced this pull request Feb 21, 2018
@anntzer
Backport PR #10551: Simplify rst cross references by omitting the sho…
333fbff 
…rtener ~ when not needed
@lumberbot-app lumberbot-app bot mentioned this pull request Feb 21, 2018
Merged
tacaswell added a commit that referenced this pull request Feb 21, 2018
@tacaswell
Merge pull request #10553 from matplotlib/auto-backport-of-pr-10551
69e4e89 
Backport PR #10551 on branch v2.2.x
@timhoffm timhoffm deleted the simplify-rst-crossref branch March 4, 2018 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tacaswell tacaswell tacaswell approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v2.2.0
Development

Successfully merging this pull request may close these issues.
3 participants
@timhoffm 337F @anntzer @tacaswell
0