Skip to content

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

Merged
emilk merged 1 commit into
emilk:masterfrom
GuillaumeGomez:link-to-def
Aug 30, 2024
Merged

emilk merged 1 commit into
emilk:masterfrom
GuillaumeGomez:link-to-def

Conversation

@GuillaumeGomez

Copy link
Copy Markdown
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. :)

@GuillaumeGomez
GuillaumeGomez requested a review from Wumpf as a code owner August 29, 2024 14:20
@emilk

emilk commented Aug 30, 2024

Copy link
Copy Markdown
Owner

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

GuillaumeGomez commented Aug 30, 2024

Copy link
Copy Markdown
Contributor Author

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