Skip to content

Fix examples that use missing_docs lint #31219

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 28, 2016
Merged

Fix examples that use missing_docs lint #31219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions src/doc/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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