Fix invalid docs path for compiler plugins #46463
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @aturon (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
kennytm
added
the
S-waiting-on-review
| @@ -29,7 +29,7 @@ use rustc_plugin::Registry; | |||
| // WARNING WARNING WARNING WARNING WARNING | |||
| // ======================================= | |||
| // | |||
| // This code also appears in src/doc/guide-plugin.md. Please keep | |||
| // This code also appears in src/doc/unstable-book. Please keep | |||
There was a problem hiding this comment.
Why not use the full path src/doc/unstable-book/src/language-features/plugin.md?
There was a problem hiding this comment.
I made it consistent with the manner in other code feature_gate.rs#L106.
// If you change this, please modify src/doc/unstable-book as well.
There was a problem hiding this comment.
The difference is that the comment in feature_gate.rs applies to every feature listed in the code below it, so pointing to the folder makes sense. The test case here only refers to a single feature.
There was a problem hiding this comment.
Oh, I understand. Thank you @kennytm . I updated it.
|
@bors r+ rollup |
|
📌 Commit 3e46fa2 has been approved by |
Fix invalid docs path for compiler plugins The path to the docs `src/doc/guide-plugin.md` moved to `src/doc/unstable-book/src/language-features/plugin.md`. This patch updates it in the comment of WARNING message of the test code.
kennytm
added
S-waiting-on-bors
|
☀️ Test successful - status-appveyor, status-travis |
The path to the docs
src/doc/guide-plugin.mdmoved tosrc/doc/unstable-book/src/language-features/plugin.md.This patch updates it in the comment of WARNING message of the test
code.