Skip to content
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 from
Closed

Conversation

@bansalnitish
Copy link
Contributor

@bansalnitish bansalnitish commented Feb 27, 2018

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

@bansalnitish bansalnitish force-pushed the ref-fix branch 7 times, most recently from 4fa51ee to 1b56f9d Feb 27, 2018
@agjohnson
Copy link
Contributor

@agjohnson 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?

Loading

@stsewd
Copy link
Member

@stsewd 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

Loading

@bansalnitish
Copy link
Contributor Author

@bansalnitish 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.

Loading

@stsewd
Copy link
Member

@stsewd 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.

Loading

@bansalnitish
Copy link
Contributor Author

@bansalnitish bansalnitish commented Feb 28, 2018

That is great @stsewd!

Loading

@bansalnitish
Copy link
Contributor Author

@bansalnitish bansalnitish commented Mar 7, 2018

HI @stsewd, any updates on this!

Loading

@stsewd
Copy link
Member

@stsewd stsewd commented Mar 7, 2018

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

Loading

@bansalnitish
Copy link
Contributor Author

@bansalnitish bansalnitish commented Mar 8, 2018

Thanks, @stsewd! I am closing this one!

Loading

@bansalnitish bansalnitish deleted the ref-fix branch Mar 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants