about summary refs log tree commit diff
diff options
context:
space:
mode:
authorManish Goregaokar <manishsmail@gmail.com>2020-07-06 17:45:17 -0700
committerGitHub <noreply@github.com>2020-07-06 17:45:17 -0700
commit3f90287bb607e5061350517c63240e14e0d25e46 (patch)
tree038d89bd9f0563dff4b7ac8ecab400f83fad4395
parent218d96ed6b7d57bd5d8c38f649a22b8d4ac31c25 (diff)
parent36e50a0fb3e91552425bbae89aba411e46c4c27a (diff)
downloadrust-3f90287bb607e5061350517c63240e14e0d25e46.tar.gz
rust-3f90287bb607e5061350517c63240e14e0d25e46.zip
Rollup merge of #73856 - pierwill:pierwill-lexer-doc, r=jonas-schievink
Edit librustc_lexer top-level docs

Minor edit, and adds link to librustc_parse::lexer.
-rw-r--r--src/librustc_lexer/src/lib.rs9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/librustc_lexer/src/lib.rs b/src/librustc_lexer/src/lib.rs
index 2f4b1bbd3ba..862ffd50d38 100644
--- a/src/librustc_lexer/src/lib.rs
+++ b/src/librustc_lexer/src/lib.rs
@@ -6,17 +6,18 @@
 //! produces simple tokens which are a pair of type-tag and a bit of original text,
 //! and does not report errors, instead storing them as flags on the token.
 //!
-//! Tokens produced by this lexer are not yet ready for parsing the Rust syntax,
-//! for that see `librustc_parse::lexer`, which converts this basic token stream
+//! Tokens produced by this lexer are not yet ready for parsing the Rust syntax.
+//! For that see [`librustc_parse::lexer`], which converts this basic token stream
 //! into wide tokens used by actual parser.
 //!
 //! The purpose of this crate is to convert raw sources into a labeled sequence
 //! of well-known token types, so building an actual Rust token stream will
 //! be easier.
 //!
-//! Main entity of this crate is [`TokenKind`] enum which represents common
+//! The main entity of this crate is the [`TokenKind`] enum which represents common
 //! lexeme types.
-
+//!
+//! [`librustc_parse::lexer`]: ../rustc_parse/lexer/index.html
 // We want to be able to build this crate with a stable compiler, so no
 // `#![feature]` attributes should be added.