diff options
| author | pierwill <pierwill@users.noreply.github.com> | 2020-06-28 16:32:28 -0700 |
|---|---|---|
| committer | pierwill <pierwill@users.noreply.github.com> | 2020-07-06 16:01:47 -0700 |
| commit | 36e50a0fb3e91552425bbae89aba411e46c4c27a (patch) | |
| tree | 9951b677b8a44c3a55a4583fba42465c0a4f7c8d /src | |
| parent | 2f517ce6f28b5d638cce4c1eccdbe63255b11420 (diff) | |
| download | rust-36e50a0fb3e91552425bbae89aba411e46c4c27a.tar.gz rust-36e50a0fb3e91552425bbae89aba411e46c4c27a.zip | |
Edit librustc_lexer top-level docs
Add link to librustc_parse::lexer
Diffstat (limited to 'src')
| -rw-r--r-- | src/librustc_lexer/src/lib.rs | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/librustc_lexer/src/lib.rs b/src/librustc_lexer/src/lib.rs index 77b3d26463d..294a2ee4ab7 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. |
