diff options
| author | Laurenz <laurmaedje@gmail.com> | 2019-05-26 21:59:33 +0200 |
|---|---|---|
| committer | Laurenz <laurmaedje@gmail.com> | 2019-05-26 21:59:33 +0200 |
| commit | c38e17d91f81632422171b8103ce90baacfdbe22 (patch) | |
| tree | 757387b885bd5f0785dbafbf1704fb280dd4a269 /src/syntax.rs | |
| parent | b3734bbc046fe7b14cff54e2dae7014a71014777 (diff) | |
Thoroughly improve documentation 📝
Diffstat (limited to 'src/syntax.rs')
| -rw-r--r-- | src/syntax.rs | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/src/syntax.rs b/src/syntax.rs index b3f1d04d..cfd41719 100644 --- a/src/syntax.rs +++ b/src/syntax.rs @@ -17,8 +17,8 @@ pub enum Token<'s> { RightBracket, /// A colon (`:`) indicating the beginning of function arguments. /// - /// If a colon occurs outside of a function header, it will be - /// tokenized as a [Word](Token::Word). + /// If a colon occurs outside of a function header, it will be tokenized as a + /// [Word](Token::Word). Colon, /// An equals (`=`) sign assigning a function argument a value. /// @@ -34,9 +34,8 @@ pub enum Token<'s> { LineComment(&'s str), /// A block comment. BlockComment(&'s str), - /// A star followed by a slash unexpectedly ending a block comment - /// (the comment was not started before, otherwise a - /// [BlockComment](Token::BlockComment) would be returned). + /// A star followed by a slash unexpectedly ending a block comment (the comment was not started + /// before, otherwise a [BlockComment](Token::BlockComment) would be returned). StarSlash, /// Everything else is just text. Text(&'s str), @@ -64,11 +63,11 @@ pub enum Node { Space, /// A line feed. Newline, - /// Indicates that italics were enabled/disabled. + /// Indicates that italics were enabled / disabled. ToggleItalics, - /// Indicates that boldface was enabled/disabled. + /// Indicates that boldface was enabled / disabled. ToggleBold, - /// Indicates that math mode was enabled/disabled. + /// Indicates that math mode was enabled / disabled. ToggleMath, /// Literal text. Text(String), |