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

Add #![deny(missing_docs)] #118

Merged
merged 2 commits into from
Oct 24, 2016
Merged

Conversation

fitzgen
Copy link
Member

@fitzgen fitzgen commented Oct 24, 2016

This commit adds the #![deny(missing_docs)] pragma, which causes
compilation to fail if a public type or function is missing a
documentation comment. It also adds missing documentation comments for
public types and functions that were missing them.

Fixes #94

r? @emilio

This commit adds the `#![deny(missing_docs)]` pragma, which causes
compilation to fail if a public type or function is missing a
documentation comment. It also adds missing documentation comments for
public types and functions that were missing them.
Copy link
Contributor

@emilio emilio left a comment

Choose a reason for hiding this comment

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

This is awesome, r=me with this nit.

pub builtins: bool,

/// The set of libraries we should link in the generated Rust code.
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add a FIXME here pointing to #104?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@emilio
Copy link
Contributor

emilio commented Oct 24, 2016

@bors-servo: delegate+

@bors-servo
Copy link

✌️ @fitzgen can now approve this pull request

@fitzgen
Copy link
Member Author

fitzgen commented Oct 24, 2016

@bors-servo r=emilio

@bors-servo
Copy link

📌 Commit fcfb8e5 has been approved by emilio

@bors-servo
Copy link

⌛ Testing commit fcfb8e5 with merge e06aab1...

bors-servo pushed a commit that referenced this pull request Oct 24, 2016
Add `#![deny(missing_docs)]`

This commit adds the `#![deny(missing_docs)]` pragma, which causes
compilation to fail if a public type or function is missing a
documentation comment. It also adds missing documentation comments for
public types and functions that were missing them.

Fixes #94

r? @emilio
@bors-servo
Copy link

☀️ Test successful - status-travis

@bors-servo bors-servo merged commit fcfb8e5 into rust-lang:master Oct 24, 2016
@fitzgen fitzgen deleted the deny-missing-docs branch October 24, 2016 21:38
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

Successfully merging this pull request may close these issues.

4 participants