rustdoc-json-types: update ProcMacro docs section on helper attributes
#130939
Conversation
I believe the mention of attribute macros in the section on proc macro helper attributes is erroneous. As far as I can tell, attribute macros cannot define helper attributes.
The following attribute macro is not valid (fails to build), no matter how I try to define (or skip defining) the helpers:
```rust
#[proc_macro_attribute(attributes(helper))]
pub fn attribute_helpers(_attr: TokenStream, item: TokenStream) -> TokenStream {
item
}
```
The [language reference](https://doc.rust-lang.org/reference/procedural-macros.html#attribute-macros) also doesn't seem to mention attribute macro helpers. The helpers subsection is inside the section on derive macros.
|
r? @notriddle rustbot has assigned @notriddle. Use |
rustbot
added
A-rustdoc-json
|
rustdoc-json-types is a public (although nightly-only) API. If possible, consider changing |
|
I considered bumping the |
|
I'm not very familiar with rustdoc-json, and don't feel comfortable reviewing these in general (though this particular change seems harmless). |
This is correct, the “rule” (that should be written down 😔) is that it needs to be bumped when for changes that would cause deserialisation to fail. @bors r+ rollup |
|
🌲 The tree is currently closed for pull requests below priority 100. This pull request will be tested once the tree is reopened. |
bors
added
S-waiting-on-bors
aDotInTheVoid
changed the title
ProcMacro docs section on helper attributesProcMacro docs section on helper attributes
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#125404 (Fix `read_buf` uses in `std`) - rust-lang#130866 (Allow instantiating object trait binder when upcasting) - rust-lang#130922 (Reference UNSPECIFIED instead of INADDR_ANY in join_multicast_v4) - rust-lang#130924 (Make clashing_extern_declarations considering generic args for ADT field) - rust-lang#130939 (rustdoc: update `ProcMacro` docs section on helper attributes) - rust-lang#130940 (Revert space-saving operations) - rust-lang#130944 (Allow instantiating trait object binder in ptr-to-ptr casts) - rust-lang#130953 (Rename a few tests to make tidy happier) r? `@ghost` `@rustbot` modify labels: rollup
Rollup merge of rust-lang#130939 - obi1kenobi:patch-2, r=aDotInTheVoid rustdoc: update `ProcMacro` docs section on helper attributes I believe the mention of attribute macros in the section on proc macro helper attributes is erroneous. As far as I can tell, attribute macros cannot define helper attributes. The following attribute macro is not valid (fails to build), no matter how I try to define (or skip defining) the helpers: ```rust #[proc_macro_attribute(attributes(helper))] pub fn attribute_helpers(_attr: TokenStream, item: TokenStream) -> TokenStream { item } ``` The [language reference](https://doc.rust-lang.org/reference/procedural-macros.html#attribute-macros) also doesn't seem to mention attribute macro helpers. The helpers subsection is inside the section on derive macros.
I believe the mention of attribute macros in the section on proc macro helper attributes is erroneous. As far as I can tell, attribute macros cannot define helper attributes.
The following attribute macro is not valid (fails to build), no matter how I try to define (or skip defining) the helpers:
The language reference also doesn't seem to mention attribute macro helpers. The helpers subsection is inside the section on derive macros.