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.

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

Fixes internal reference #3695

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
3 participants
@bansalnitish
Contributor

bansalnitish commented Feb 27, 2018

This PR fixes an internal reference in abandoned-projects.rst

@agjohnson

This comment has been minimized.

Contributor

agjohnson commented Feb 28, 2018

The reference looks like it should work just fine, and appears to do so in testing this in our docs. Is there a specific issue this is addressing?

@stsewd

This comment has been minimized.

Member

stsewd commented Feb 28, 2018

I can also see that this works fine on the docs. @bansalnitish this references are created implicitly from the title http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#implicit-hyperlink-targets

@bansalnitish

This comment has been minimized.

Contributor

bansalnitish commented Feb 28, 2018

@agjohnson @stsewd I changed the reference from implicit to explicit because implicit references are mostly error-prone when we rename sections or try to duplicate them. Using ref is better than using links to sections because it works across files, when section headings are changed, and for all builders that support cross-references.

@stsewd

This comment has been minimized.

Member

stsewd commented Feb 28, 2018

@bansalnitish By the way there is a PR in progress #3624 to catch that kind of errors on the docs.

@bansalnitish

This comment has been minimized.

Contributor

bansalnitish commented Feb 28, 2018

That is great @stsewd!

@bansalnitish

This comment has been minimized.

Contributor

bansalnitish commented Mar 7, 2018

HI @stsewd, any updates on this!

@stsewd

This comment has been minimized.

Member

stsewd commented Mar 7, 2018

@bansalnitish Not sure if this PR is really needed since the current ref works just fine.

@bansalnitish

This comment has been minimized.

Contributor

bansalnitish commented Mar 8, 2018

Thanks, @stsewd! I am closing this one!

@bansalnitish bansalnitish deleted the bansalnitish:ref-fix branch Mar 8, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment