-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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 more clickable struct names in comments #1419
Conversation
This allows them to be clicked when viewed through a code editor
Thank you for this! Unfortunately it is not enough to just enclose in You can see the problem by running cargo doc -p emath -p epaint -p egui -p eframe -p epi -p egui_web -p egui-winit -p egui_glium -p egui_glow --lib --no-deps --all-features
…
warning: unresolved link to `PathShapes`
--> epaint/src/bezier.rs:57:56
|
57 | /// Convert the cubic Bézier curve to one or two [`PathShapes`].
| ^^^^^^^^^^ no item named `PathShapes` in scope
|
= note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` (unfortunately I haven't figured out how to get |
Whoops, I assumed they were working as VSCode did correctly place links on them. Will fix it. |
Maybe adding |
…omment-links" This reverts commit 34e0cf8.
Github decided to not properly commit the changes, oh well
One fight with github's merging later this should be ready for merging with no more broken links. |
Spoke too soon, that one does not show on my machine but it does on CI. Maybe caused by #1125 stopping the build from completing. |
Wow, you are amazing for doing all this work! There are still 12 broken links with
|
Thanks ❤️ |
Replaced all instances found through the following regex:
Tried to keep it conservative as to not make false positives, haven't found any wrong replacements myself.
Example of a clickable struct name:
![](https://camo.githubusercontent.com/b412cdb53b2724bcaca390fc7b03067254348f6c242f2f696dc43d0bbc8877df/68747470733a2f2f6d656469612e646973636f72646170702e6e65742f6174746163686d656e74732f3930303238353839363932393139383039302f3935363238303139303836353134313834302f756e6b6e6f776e2e706e67)