Add --generate-link-to-definition option when building on docs.rs#3265
Closed
GuillaumeGomez wants to merge 1 commit intohyperium:masterfrom
Closed
Add --generate-link-to-definition option when building on docs.rs#3265GuillaumeGomez wants to merge 1 commit intohyperium:masterfrom
--generate-link-to-definition option when building on docs.rs#3265GuillaumeGomez wants to merge 1 commit intohyperium:masterfrom
Conversation
Member
|
Is there a reason this isn't enabled by default? |
Contributor
Author
|
Some members of the rustdoc team are opposed to this feature. The RFC is ready but not open (and very likely won't be before long): GuillaumeGomez/rfcs#1 |
Member
|
I think I'd lean towards leaving it to the defaults. If the rustdoc team eventually feels it should be enabled, we'll get it automatically. |
Contributor
Author
|
As you prefer. You know you have the possibility to enable it now so don't hesitate to use it, it's quite a convenient feature. Anyway, closing in the meantime. |
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
2 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.
This option generates links in source code pages, allowing to jump to definition and to jump back to doc. It makes browsing the source code pages much nicer. You can see it in action here.