Skip to content

/api-guidelines

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

When to use doc(hidden) #27

Closed
dtolnay opened this Issue Apr 5, 2017 · 1 comment

Comments

Assignees
No one assigned
Labels
important new guideline
Projects
None yet
Milestone
No milestone
2 participants
@dtolnay @brson
@dtolnay
Copy link
Member

dtolnay commented Apr 5, 2017

I think lazy_static does a nice job of this. How about a guideline to be mindful that formal rustdoc is supposed to include everything users need to use the crate fully, and nothing more. Okay to explain implementation details in prose (like lazy_static does) but they should not be real entries in the documentation.

@brson brson added the important label Jun 30, 2017

@dtolnay dtolnay added the new guideline label Sep 18, 2017

@dtolnay

This comment has been minimized.

Sign in to view
Copy link
Member Author

dtolnay commented Oct 29, 2017

Added in 24db1bb.

@dtolnay dtolnay closed this Oct 29, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.