Document why rust-analyzer doesn't show action name in action docs #23072
Conversation
cla-bot
bot
added
the
cla-signed
|
| #[doc = stringify!($name)] | ||
| #[doc = "` action, see [`gpui::actions!`]"] | ||
| #[doc = "action generated by `gpui::actions!`"] |
There was a problem hiding this comment.
Did we lose a space here?
Seems like action would run together with the preceding action name.
There was a problem hiding this comment.
We didn't! The macro expanded code is
///NoAction
///action generated by `gpui::actions!`
There was a problem hiding this comment.
Hmm, it seems like the #[doc = stringify!($name)] might not be doing anything, then (or at least, not doing what I think it would)?
Because when I hover an action all I see is this:
And the action name is nowhere to be seen 🤔
There was a problem hiding this comment.
Correct! That's what the comment this added is about
// Unfortunately rust-analyzer doesn't display the name due to
// rust-lang/rust-analyzer#8092
Before it was even worse because it had the empty backticks so rust analyzer's view of the doc comment was like it was written:
/// The `
///
/// ` action generated by `gpui::actions!`
mgsloan
deleted the
document-why-rust-analyzer-docs-on-generated-actions-dont-have-names
branch
rust-analyzer does not support derive_macro expansion in attributes - rust-lang/rust-analyzer#8092. This could be worked around via a proc_macro, but I think it'd be best to just require docs for every action.
Release Notes: