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

Replace deprecated missing_doc attribute. #18522

Merged
merged 1 commit into from
Nov 3, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Replace deprecated missing_doc attribute.
  • Loading branch information
jbcrail committed Nov 2, 2014
commit 835b92efb80c85764070e40df9216dd9e1a7caf4
16 changes: 8 additions & 8 deletions src/doc/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2100,15 +2100,15 @@ plugins](guide-plugin.html#lint-plugins) can provide additional lint checks.
```{.ignore}
mod m1 {
// Missing documentation is ignored here
#[allow(missing_doc)]
#[allow(missing_docs)]
pub fn undocumented_one() -> int { 1 }

// Missing documentation signals a warning here
#[warn(missing_doc)]
#[warn(missing_docs)]
pub fn undocumented_too() -> int { 2 }

// Missing documentation signals an error here
#[deny(missing_doc)]
#[deny(missing_docs)]
pub fn undocumented_end() -> int { 3 }
}
```
Expand All @@ -2117,16 +2117,16 @@ This example shows how one can use `allow` and `warn` to toggle a particular
check on and off.

```{.ignore}
#[warn(missing_doc)]
#[warn(missing_docs)]
mod m2{
#[allow(missing_doc)]
#[allow(missing_docs)]
mod nested {
// Missing documentation is ignored here
pub fn undocumented_one() -> int { 1 }

// Missing documentation signals a warning here,
// despite the allow above.
#[warn(missing_doc)]
#[warn(missing_docs)]
pub fn undocumented_two() -> int { 2 }
}

Expand All @@ -2139,10 +2139,10 @@ This example shows how one can use `forbid` to disallow uses of `allow` for
that lint check.

```{.ignore}
#[forbid(missing_doc)]
#[forbid(missing_docs)]
mod m3 {
// Attempting to toggle warning signals an error here
#[allow(missing_doc)]
#[allow(missing_docs)]
/// Returns 2.
pub fn undocumented_too() -> int { 2 }
}
Expand Down
2 changes: 1 addition & 1 deletion src/etc/unicode.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

// NOTE: The following code was generated by "src/etc/unicode.py", do not edit directly

#![allow(missing_doc, non_uppercase_statics, non_snake_case)]
#![allow(missing_docs, non_uppercase_statics, non_snake_case)]
'''

# Mapping taken from Table 12 from:
Expand Down
2 changes: 1 addition & 1 deletion src/test/run-pass/issue-10853.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#![deny(missing_doc)]
#![deny(missing_docs)]
#![doc="module"]

#[doc="struct"]
Expand Down