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

Add --generate-link-to-definition option when building on docs.rs #3265

Closed

Conversation

GuillaumeGomez
Copy link
Contributor

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.

@seanmonstar
Copy link
Member

Is there a reason this isn't enabled by default?

@GuillaumeGomez
Copy link
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

@seanmonstar
Copy link
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.

@GuillaumeGomez
Copy link
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.

@GuillaumeGomez GuillaumeGomez deleted the generate-links-to-def branch July 15, 2023 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants