You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Generate documentation for raw attributes from Command builder setter methods. These should not conflict with magic attributes with the same name: those should take precedent. This may help improve discoverability for those reading the higher-level tutorial/docs, but will generate a lot of content. Perhaps each attribute's documentation should generate a separate page that can be #[doc = include_str!(...)] on the member.
Kind of an out-there idea is we could create a cargo xtask to use rustdoc json output (nightly only) to extract all of the builder methods that may be used as an attribute and inject that into the reference, linking to the builder methods. This would improve discoverability but wouldn't help with providing derive-specific examples. We'd also have to deal with the overlap between magic attributes that also have a builder method.
Right now, I'm leaning towards a bullet list of all raw attributes for a type in a format similar to magic attributes (<name> = <something> when single argument, <name>(<something>) for multi-argument). <name> would link to the builder method and <something> can use the arg name but link to the arg type.
The list will be big, Keeping our flat derive ref will likely be a no-go. Having a page for raw attributes will be bad for searching. We likely will need a page per attribute type with magic and then raw attributes. We can use #[doc(path)] to pull in the generated pages.
epage
added
A-docs
Area: documentation, including docs.rs, readme, examples, etc...
E-medium
Call for participation: Experience needed to fix: Medium / intermediate
labels
Aug 9, 2024
Generate documentation for raw attributes from
Command
builder setter methods. These should not conflict with magic attributes with the same name: those should take precedent. This may help improve discoverability for those reading the higher-level tutorial/docs, but will generate a lot of content. Perhaps each attribute's documentation should generate a separate page that can be#[doc = include_str!(...)]
on the member.The text was updated successfully, but these errors were encountered: