roc-lang/roc
1
1
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2024-10-05 06:37:26 +03:00
Code Issues Packages Projects Releases Wiki Activity

better formatting for word docs

Browse Source
This commit is contained in:
Trevor Settles 2024-03-03 11:15:09 -07:00
parent ff19d1b834
commit b7181af8f3
No known key found for this signature in database
GPG Key ID: F46B83058222DBAA
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
crates/compiler/parse/src/parser.rs
View File

@ -1519,7 +1519,10 @@ where
}
}
/// Matches an entire `str` and moves the state's position forward if it succeeds
///
/// # Example
/// ## Success case
/// ```rust
/// # use roc_parse::state::{State};
/// # use crate::roc_parse::parser::{Parser, Progress, word};
@ -1531,14 +1534,15 @@ where
/// # }
/// # fn foo() {
/// # let arena = Bump::new();
/// let parser = word("hello", Problem::NotFound);
/// let (progress, m, state) = parser.parse(&arena, State::new("hello, world".as_bytes()), 0).unwrap();
/// assert_eq!(progress, Progress::MadeProgress);
/// assert_eq!(m, ());
/// assert_eq!(state.pos(), Position::new(5));
/// let parser = word("hello", Problem::NotFound);
/// let (progress, output, state) = parser.parse(&arena, State::new("hello, world".as_bytes()), 0).unwrap();
/// assert_eq!(progress, Progress::MadeProgress);
/// assert_eq!(output, ());
/// assert_eq!(state.pos(), Position::new(5));
/// # }
/// ```
///
/// ## Failure case
/// ```rust
/// # use roc_parse::state::{State};
/// # use crate::roc_parse::parser::{Parser, Progress, word};
@ -1550,12 +1554,12 @@ where
/// # }
/// # fn foo() {
/// # let arena = Bump::new();
/// let parser = word("bye", Problem::NotFound);
/// let actual = parser.parse(&arena, State::new("hello, world".as_bytes()), 0).map(|(a,b,_)| (a,b));
/// assert_eq!(
/// actual,
/// Err((Progress::NoProgress, Problem::NotFound(Position::zero()))),
/// );
/// let parser = word("bye", Problem::NotFound);
/// let actual = parser.parse(&arena, State::new("hello, world".as_bytes()), 0).unwrap_err();
/// assert_eq!(
/// actual,
/// (Progress::NoProgress, Problem::NotFound(Position::zero())),
/// );
/// # }
/// ```
pub fn word<'a, ToError, E>(word: &'static str, to_error: ToError) -> impl Parser<'a, (), E>