diff options
| author | Matt Brubeck <mbrubeck@limpet.net> | 2016-01-26 09:49:26 -0800 |
|---|---|---|
| committer | Matt Brubeck <mbrubeck@limpet.net> | 2016-01-26 09:49:26 -0800 |
| commit | e23f8b095b341b43a9696562889a4db096bebb9d (patch) | |
| tree | 1f8657486a344e7b214d7e347b6ee481ef02c431 /src/doc | |
| parent | 5d6e8fcedac1184a28031ee0cf63e2d862e4536f (diff) | |
| download | rust-e23f8b095b341b43a9696562889a4db096bebb9d.tar.gz rust-e23f8b095b341b43a9696562889a4db096bebb9d.zip | |
Fix examples that use missing_docs lint
The missing_docs lint only applies to public items in public modules, so this example code did not actually generate any warnings or errors.
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/reference.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md index f0fdae27ac7..46fdee2bb5a 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -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 } @@ -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 } @@ -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. |
