diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2023-01-06 21:26:10 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-06 21:26:10 +0100 |
| commit | 72d650f47a7c23d31e16f54d71f7356fbcd651f5 (patch) | |
| tree | 4dbc0094b285e79e8eec493d435a5a3e75ebafd6 /tests/rustdoc-js-std/parser-errors.js | |
| parent | 498216e9db724cb26f269b0419d4e9e2897cee79 (diff) | |
| parent | ae667be0f6017002587a28be257238655d34fa54 (diff) | |
| download | rust-72d650f47a7c23d31e16f54d71f7356fbcd651f5.tar.gz rust-72d650f47a7c23d31e16f54d71f7356fbcd651f5.zip | |
Rollup merge of #106453 - coastalwhite:master, r=GuillaumeGomez
Improve include macro documentation As outlined in #106118, the `include!` macro is a SEO problem when it comes to the Rust documentation. Beginners may see it as a replacement to `include` syntax in other languages. I feel like this documentation should quite explicitly link to the modules' documentation. The primary goal of this PR is to address that issue by adding a warning to the documentation. While I was here, I also added some other parts. This included a `Uses` section and some (intra doc) links to other relevant topics. I hope this can help beginners to Rust more quickly understand some multi-file project intricacies. # References - Syntax for the warning: https://github.com/tokio-rs/tracing/blob/58accc6da3f04af3f6144fbe6d68af7225c70c02/tracing/src/lib.rs#L55
Diffstat (limited to 'tests/rustdoc-js-std/parser-errors.js')
0 files changed, 0 insertions, 0 deletions