diff options
| author | bors <bors@rust-lang.org> | 2014-04-28 12:56:49 -0700 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2014-04-28 12:56:49 -0700 |
| commit | 23262a83909392f88fdc8031ebd754f8d9b94525 (patch) | |
| tree | b7a77740636054abed4b7ef37f51c18f4835ab3d /src/libsyntax/parse | |
| parent | 1f4278d650837bf30e5461fd15c2364b2bb5ceff (diff) | |
| parent | 6c41253a473728451283e20bef3498fdfe797243 (diff) | |
| download | rust-23262a83909392f88fdc8031ebd754f8d9b94525.tar.gz rust-23262a83909392f88fdc8031ebd754f8d9b94525.zip | |
auto merge of #13812 : alxgnon/rust/master, r=alexcrichton
This is a quick fix for repeated documentation descriptions in certain modules. Following is a list of the faulty modules I found. I ran `pcregrep -r -M "<p>(.+)\n\1" doc` on the html documentation to help identify them. - [rustuv::uvio](http://static.rust-lang.org/doc/master/rustuv/uvio/index.html) - [rustuv::uvll](http://static.rust-lang.org/doc/master/rustuv/uvll/index.html) - [std::rt::backtrace](http://static.rust-lang.org/doc/master/std/rt/backtrace/index.html) - [std::rt::env](http://static.rust-lang.org/doc/master/std/rt/env/index.html) - [std::rt::global_heap](http://static.rust-lang.org/doc/master/std/rt/global_heap/index.html) - [std::rt::local_heap](http://static.rust-lang.org/doc/master/std/rt/local_heap/index.html) - [std::rt::rtio](http://static.rust-lang.org/doc/master/std/rt/rtio/index.html) - [std::rt::task](http://static.rust-lang.org/doc/master/std/rt/task/index.html) - [std::rt::thread](http://static.rust-lang.org/doc/master/std/rt/thread/index.html) - [std::rt::unwind](http://static.rust-lang.org/doc/master/std/rt/unwind/index.html) - [syntax::parse::classify](http://static.rust-lang.org/doc/master/syntax/parse/classify/index.html) - [syntax::parse::common](http://static.rust-lang.org/doc/master/syntax/parse/common/index.html) After a little testing, I discovered that moving the documentation inside (`//!`) instead of outside (`///`) modules fixed the immediate problem. I went through the trouble of moving the documentation, and with this commit there are no more repeated descriptions within those faulty modules. This does not fix the underlying problem though. We should look into why having the documentation outside instead of inside caused the descriptions to be repeated. I will create a separate issue with my findings on the subject if necessary. In the meantime, this simple fix should be enough.
Diffstat (limited to 'src/libsyntax/parse')
| -rw-r--r-- | src/libsyntax/parse/classify.rs | 6 | ||||
| -rw-r--r-- | src/libsyntax/parse/common.rs | 2 | ||||
| -rw-r--r-- | src/libsyntax/parse/mod.rs | 5 |
3 files changed, 5 insertions, 8 deletions
diff --git a/src/libsyntax/parse/classify.rs b/src/libsyntax/parse/classify.rs index d6dcb956f25..b160593b049 100644 --- a/src/libsyntax/parse/classify.rs +++ b/src/libsyntax/parse/classify.rs @@ -8,9 +8,9 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. -/* - Predicates on exprs and stmts that the pretty-printer and parser use - */ +//! Routines the parser uses to classify AST nodes + +// Predicates on exprs and stmts that the pretty-printer and parser use use ast; diff --git a/src/libsyntax/parse/common.rs b/src/libsyntax/parse/common.rs index 0d40638d3a7..3c3f0c7a820 100644 --- a/src/libsyntax/parse/common.rs +++ b/src/libsyntax/parse/common.rs @@ -8,6 +8,8 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. +//! Common routines shared by parser mods + use parse::token; // SeqSep : a sequence separator (token) diff --git a/src/libsyntax/parse/mod.rs b/src/libsyntax/parse/mod.rs index 122cc37dfb6..0d3ae3b5cb8 100644 --- a/src/libsyntax/parse/mod.rs +++ b/src/libsyntax/parse/mod.rs @@ -28,13 +28,8 @@ pub mod token; pub mod comments; pub mod attr; -/// Common routines shared by parser mods pub mod common; - -/// Routines the parser uses to classify AST nodes pub mod classify; - -/// Reporting obsolete syntax pub mod obsolete; // info about a parsing session. |
