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.

Sign up for GitHub

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

Jump to bottom

trpl: mention missing_docs lint #28922

Merged
merged 3 commits into from
Oct 10, 2015
Merged

trpl: mention missing_docs lint #28922

merged 3 commits into from
Oct 10, 2015

Conversation

panicbit
Copy link
Contributor

@panicbit panicbit commented Oct 9, 2015

No description provided.

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

killercup
killercup reviewed Oct 9, 2015
View reviewed changes
src/doc/trpl/documentation.md
@@ -546,6 +546,31 @@ extern crate foo;
pub use foo::bar;
```

## Missing documentation

Sometimes you want to make sure that every single thing in your project is
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"every single public thing"?

@killercup
Copy link
Member

Nice, I'm using this all the time.

Might be good place to mention #[doc(hidden)] as well.

@panicbit
Copy link
Contributor Author

panicbit commented Oct 9, 2015

@killercup What's the difference between #[doc(hidden)] and normal comments?

@killercup
Copy link
Member

It hides elements that would otherwise be included by rustdoc.
panicbit [email protected] schrieb am Fr., 9. Okt. 2015 um 13:59:

@killercup https://github.com/killercup What's the difference between
#[doc(hidden)] and normal comments?

—
Reply to this email directly or view it on GitHub
#28922 (comment).

@panicbit
Copy link
Contributor Author

panicbit commented Oct 9, 2015

@killercup Thanks!

@panicbit panicbit closed this Oct 10, 2015
@panicbit panicbit reopened this Oct 10, 2015
@panicbit
Copy link
Contributor Author

Reopened to restart the travis build. It looks like it just failed to download some files.

@steveklabnik
Copy link
Member

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Oct 10, 2015

📌 Commit cf785d1 has been approved by steveklabnik

@steveklabnik
Copy link
Member

Thanks!

@bors
Copy link
Contributor

bors commented Oct 10, 2015

⌛ Testing commit cf785d1 with merge e3cd872...

bors added a commit that referenced this pull request Oct 10, 2015
@bors
Auto merge of #28922 - panicbit:trpl-missing-docs, r=steveklabnik
e3cd872
@bors
Copy link
Contributor

bors commented Oct 10, 2015

☀️ Test successful - auto-linux-32-nopt-t, auto-linux-32-opt, auto-linux-64-nopt-t, auto-linux-64-opt, auto-linux-64-x-android-t, auto-mac-32-opt, auto-mac-64-nopt-t, auto-mac-64-opt, auto-win-gnu-32-nopt-t, auto-win-gnu-32-opt, auto-win-gnu-64-nopt-t, auto-win-gnu-64-opt, auto-win-msvc-32-opt, auto-win-msvc-64-opt

@bors bors merged commit cf785d1 into rust-lang:master Oct 10, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@steveklabnik steveklabnik

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@panicbit @rust-highfive @killercup @steveklabnik @bors