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

Enable rustdoc generate-link-to-definition feature on docs.rs #5030

Merged
merged 1 commit into from
Aug 30, 2024

Conversation

GuillaumeGomez
Copy link
Contributor

You can see this feature in action here or on any of dtolnay's crates and many others. I found myself going through your project code recently on docs.rs and I was a bit sad I couldn't have this feature enabled. This should fix it at next release. :)

@emilk
Copy link
Owner

emilk commented Aug 30, 2024

Very cool feature; I didn't know about this!

Why is it opt-in and not enabled by default?

@emilk emilk added docs and examples Improving and adding documentation and examples egui labels Aug 30, 2024
@GuillaumeGomez
Copy link
Contributor Author

GuillaumeGomez commented Aug 30, 2024

Not stable and likely won't be before a long time. There are some disagreements in the rustdoc team about how we should implement this feature or whether or not we should even have this feature in the first place. "politics"

@emilk emilk merged commit da04339 into emilk:master Aug 30, 2024
21 of 22 checks passed
@GuillaumeGomez GuillaumeGomez deleted the link-to-def branch August 30, 2024 09:24
486c pushed a commit to 486c/egui that referenced this pull request Oct 9, 2024
…k#5030)

You can see this feature in action
[here](https://docs.rs/sysinfo/latest/src/sysinfo/common/system.rs.html#46)
or on any of dtolnay's crates and many others. I found myself going
through your project code recently on docs.rs and I was a bit sad I
couldn't have this feature enabled. This should fix it at next release.
:)
hacknus pushed a commit to hacknus/egui that referenced this pull request Oct 30, 2024
…k#5030)

You can see this feature in action
[here](https://docs.rs/sysinfo/latest/src/sysinfo/common/system.rs.html#46)
or on any of dtolnay's crates and many others. I found myself going
through your project code recently on docs.rs and I was a bit sad I
couldn't have this feature enabled. This should fix it at next release.
:)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs and examples Improving and adding documentation and examples egui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants