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
Unfortunately after all these years rustdoc still does support type aliases very well. In code, type aliases are really useful for filing in some generic type parameters and simplifying the resulting type. However, the resulting documentation does not present the impls for these type aliases, and only points to the (often vastly more complicated) generic type documentation. Some key examples in nannou are the Drawing* types and the Text iterator return types (e.g. Glyphs).
Perhaps it's worth reviewing the use of all the cases where we use pub type = and seeing if we can use struct wrapper types on which we can provide better docs? This isn't possible in the case of the Drawing type, but might be possible elsewhere.
Alternatively it might be worth trying to fix rustdoc itself - see the linked issues below.
Unfortunately after all these years
rustdoc
still does support type aliases very well. In code, type aliases are really useful for filing in some generic type parameters and simplifying the resulting type. However, the resulting documentation does not present theimpl
s for these type aliases, and only points to the (often vastly more complicated) generic type documentation. Some key examples in nannou are theDrawing*
types and theText
iterator return types (e.g.Glyphs
).Perhaps it's worth reviewing the use of all the cases where we use
pub type =
and seeing if we can use struct wrapper types on which we can provide better docs? This isn't possible in the case of theDrawing
type, but might be possible elsewhere.Alternatively it might be worth trying to fix rustdoc itself - see the linked issues below.
Related issues:
draw.line()
, draw.eclipse()`, etc methods #252The text was updated successfully, but these errors were encountered: