diff options
| author | Joseph Crail <jbcrail@gmail.com> | 2014-11-01 21:12:13 -0400 |
|---|---|---|
| committer | Joseph Crail <jbcrail@gmail.com> | 2014-11-01 21:12:13 -0400 |
| commit | 835b92efb80c85764070e40df9216dd9e1a7caf4 (patch) | |
| tree | 2ec37e46b792262b8a363398d0639ba3b4e88cbb /src/doc/reference.md | |
| parent | 0547a407aa03b9f1c03843aead617a2e8c5d1147 (diff) | |
| download | rust-835b92efb80c85764070e40df9216dd9e1a7caf4.tar.gz rust-835b92efb80c85764070e40df9216dd9e1a7caf4.zip | |
Replace deprecated missing_doc attribute.
Diffstat (limited to 'src/doc/reference.md')
| -rw-r--r-- | src/doc/reference.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md index 084309e9978..79a94319e2c 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -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 } } ``` @@ -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 } } @@ -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 } } |
