diff options
| author | bors <bors@rust-lang.org> | 2013-05-30 00:37:35 -0700 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2013-05-30 00:37:35 -0700 |
| commit | ca74cbdc5cc7747e429a985b7b5fb5c4e4a5d4d5 (patch) | |
| tree | 305a99cf736df82bef843fcfdf9270ad237f1f2e /src/libstd/cmp.rs | |
| parent | 31b2804fdab0046b139399589eab74995da3c265 (diff) | |
| parent | 395685079a2ef21c93a90ff6ccac2873b3013c7f (diff) | |
| download | rust-ca74cbdc5cc7747e429a985b7b5fb5c4e4a5d4d5.tar.gz rust-ca74cbdc5cc7747e429a985b7b5fb5c4e4a5d4d5.zip | |
auto merge of #6798 : alexcrichton/rust/doc-lints, r=pcwalton
These commits perform a variety of actions: 1. The linting of missing documentation has been consolidated under one `missing_doc` attribute, and many more things are linted about. 2. A test was added for linting missing documentation, which revealed a large number of corner cases in both linting and the `missing_doc` lint pass. Some notable edge cases: * When compiling with `--test`, all `missing_doc` warnings are suppressed * If any parent of the current item has `#[doc(hidden)]`, then the `missing_doc` warning is suppressed 3. Both the std and extra libraries were modified to `#[deny(missing_doc)]` by default. I believe that the libraries are getting to the point where they're fairly well documented, and they should definitely stay that way. If developing a particular new module, it's easy enough to add `#[allow(missing_doc)]` at the top, but those should definitely be flags for removal in favor of actual documentation. I added as much documentation as I could throughout std/extra, although I avoided trying to document things that I knew nothing about. I can't say that this lint pass will vouch for the quality of the documentation of std/extra, but it will certainly make sure that there's at least some describing words. That being said, I may have a different opinion, so I don't mind amending these commits to turn off the lint by default for std/extra if people think otherwise.
Diffstat (limited to 'src/libstd/cmp.rs')
| -rw-r--r-- | src/libstd/cmp.rs | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/libstd/cmp.rs b/src/libstd/cmp.rs index ca9c49b2c06..55530f181a1 100644 --- a/src/libstd/cmp.rs +++ b/src/libstd/cmp.rs @@ -20,6 +20,8 @@ and `Eq` to overload the `==` and `!=` operators. */ +#[allow(missing_doc)]; + /** * Trait for values that can be compared for equality and inequality. * |
