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

Limit documentation of library features in the unstable book #41288

Closed
est31 opened this issue Apr 13, 2017 · 1 comment
Closed

Limit documentation of library features in the unstable book #41288

est31 opened this issue Apr 13, 2017 · 1 comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools

Comments

@est31
Copy link
Member

est31 commented Apr 13, 2017

I think documentation for library/std features should be put into rustdoc instead of the unstable book, as that is the most likely place to read about the functionality, and best suited in various ways. I propose to only include minimal documentation for them, like name, a link to the tracking issue, and maybe a link to the rustdoc of the places its used.

Also, they should be in their own section, and the tidy lints should enforce it.

@est31 est31 changed the title Don't document library features in the unstable book Limit documentation of library features in the unstable book Apr 13, 2017
@frewsxcv frewsxcv added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Apr 14, 2017
@steveklabnik
Copy link
Member

I'm going to consider this one a dup of #41142; that is, it'd be better to talk about this in that issue (or really, an internals thread, but we already have multiple issues here) than spread this out everywhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools
Projects
None yet
Development

No branches or pull requests

3 participants