-
Notifications
You must be signed in to change notification settings - Fork 13.3k
rustdoc: Suggest to turn 'http...' into an automatic link #77501
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Comments
You can write |
You can also use |
Well how about that…this was not clear from any documentation I found. Thanks, this is certainly good enough, though I will note that GitHub, Bitbucket, and the IntelliJ Rust plugin all auto-link in this way, so it might still be worth considering from a least-surprise perspective. |
It's documented here: https://www.markdownguide.org/basic-syntax#urls-and-email-addresses Maybe rustdoc should link to a markdown guide? I don't think it necessarily needs to document all of markdown though. |
It would be reasonable to have a warm by default lint for this with a structured suggestion. |
Adding a lint for this then! |
…, r=jyn514 Add automatic_links lint Fixes rust-lang#77501. r? @jyn514
…, r=jyn514 Add automatic_links lint Fixes rust-lang#77501. r? @jyn514
…, r=jyn514,ollie27 Add non_autolinks lint Part of rust-lang#77501. r? `@jyn514`
…r=jyn514,ollie27 Add non_autolinks lint Part of rust-lang#77501. r? `@jyn514`
It would be nice if a raw hyperlink (with no markup) in a doc comment were rendered out as an anchor tag, à la GitHub. Otherwise you have to write
This would maximize readability in the code while slightly improving the generated HTML.
The text was updated successfully, but these errors were encountered: