Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review use of pub type = Foo; and the quality of the resulting documentation #539

Open
mitchmindtree opened this issue Apr 13, 2020 · 0 comments

Comments

@mitchmindtree
Copy link
Member

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.

Related issues:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant