Skip to content

Commit 0aee12c

Browse files
committed
improve documentation
1 parent cc00ead commit 0aee12c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

crates/prettytty/src/scan.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ use super::{Control, Token};
1616

1717
/// A scanner for text and control tokens.
1818
///
19-
/// This struct builds Paul Flo Williams' [parser for DEC's ANSI-compatible
19+
/// This struct builds on Paul Flo Williams' [parser for DEC's ANSI-compatible
2020
/// terminals](https://vt100.net/emu/dec_ansi_parser) to implement a state
2121
/// machine for recognizing UTF-8 characters and ANSI control sequences alike.
2222
/// Notably, [`Scanner::read_token`] produces the corresponding [`Token`]s. To
23-
/// minimize[] overhead, the implementation turns subsequent UTF-8 characters
24-
/// into text tokens. It is zero-copy as long as no control characters appear in
25-
/// the middle of control sequences. As a result, tokens have the same lifetime
26-
/// as the scanner itself, and each token must be processed before the next
23+
/// minimize overhead, the implementation turns subsequent UTF-8 characters into
24+
/// text tokens. It is zero-copy as long as no control characters appear in the
25+
/// middle of control sequences. As a result, tokens have the same lifetime as
26+
/// the scanner itself, and each token must be processed before the next
2727
/// invocation of `read_token`.
2828
///
2929
/// The implementation of the state machine has been carefully engineered to

0 commit comments

Comments
 (0)