Skip to content

Commit

Permalink
Fix examples that use missing_docs lint
Browse files Browse the repository at this point in the history
The missing_docs lint only applies to public items in public modules, so this
example code did not actually generate any warnings or errors.
  • Loading branch information
mbrubeck committed Jan 26, 2016
1 parent 5d6e8fc commit e23f8b0
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/doc/reference.md
Expand Up @@ -2095,7 +2095,7 @@ along with their default settings. [Compiler
plugins](book/compiler-plugins.html#lint-plugins) can provide additional lint checks.

```{.ignore}
mod m1 {
pub mod m1 {
// Missing documentation is ignored here
#[allow(missing_docs)]
pub fn undocumented_one() -> i32 { 1 }
Expand All @@ -2115,9 +2115,9 @@ check on and off:

```{.ignore}
#[warn(missing_docs)]
mod m2{
pub mod m2{
#[allow(missing_docs)]
mod nested {
pub mod nested {
// Missing documentation is ignored here
pub fn undocumented_one() -> i32 { 1 }
Expand All @@ -2137,7 +2137,7 @@ that lint check:

```{.ignore}
#[forbid(missing_docs)]
mod m3 {
pub mod m3 {
// Attempting to toggle warning signals an error here
#[allow(missing_docs)]
/// Returns 2.
Expand Down

0 comments on commit e23f8b0

Please sign in to comment.