Skip to content

Commit ef34c36

Browse files
author
Leo Pourcelot
committed
Fixed misleading documentation
Documentation in `reader.rs` said that functions parse `&[u8]` into other types. However, commit `f04d995` modified code so that it parses `&str`. This commit fixes the corresponding documentation.
1 parent 7bb9636 commit ef34c36

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

src/reader.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ pub fn integer(input: &str) -> IResult<&str, i32> {
149149
// reader functions, at least) that are basically composable InputType
150150
// -> IResult<InputType,Value> parsers, that our normal read function
151151
// / reader will wrap.
152-
/// Takes a parser, such as one that reads a &[u8] and returns an
152+
/// Takes a parser, such as one that reads a &str and returns an
153153
/// i32, and creates a new parser that instead returns a valid
154154
/// ClojureRS Value instead
155155
pub fn to_value_parser<I,O: ToValue>(parser: impl Fn(I) -> IResult<I,O>) -> impl Fn(I) -> IResult<I,Value> {
@@ -158,7 +158,7 @@ pub fn to_value_parser<I,O: ToValue>(parser: impl Fn(I) -> IResult<I,O>) -> impl
158158

159159
// @TODO make sure whitespace or 'nothing' is at the end, fail for
160160
// float like numbers
161-
/// Tries to parse &[u8] into Value::I32
161+
/// Tries to parse &str into Value::I32
162162
/// Expects:
163163
/// Integers
164164
/// Example Successes:
@@ -171,7 +171,7 @@ pub fn try_read_i32(input: &str) -> IResult<&str, Value> {
171171
to_value_parser(integer)(input)
172172
}
173173

174-
/// Tries to parse &[u8] into Value::Symbol
174+
/// Tries to parse &str into Value::Symbol
175175
/// Example Successes:
176176
/// a => Value::Symbol(Symbol { name: "a" })
177177
/// cat-dog => Value::Symbol(Symbol { name: "cat-dog" })
@@ -183,7 +183,7 @@ pub fn try_read_symbol(input: &str) -> IResult<&str, Value> {
183183
}
184184

185185
// @TODO allow escaped strings
186-
/// Tries to parse &[u8] into Value::String
186+
/// Tries to parse &str into Value::String
187187
/// Example Successes:
188188
/// "this is pretty straightforward" => Value::String("this is pretty straightforward")
189189
pub fn try_read_string(input: &str) -> IResult<&str, Value> {
@@ -202,7 +202,7 @@ pub fn try_read_string(input: &str) -> IResult<&str, Value> {
202202
}
203203

204204
// @TODO Perhaps generalize this, or even generalize it as a reader macro
205-
/// Tries to parse &[u8] into Value::PersistentListMap, or some other Value::..Map
205+
/// Tries to parse &str into Value::PersistentListMap, or some other Value::..Map
206206
/// Example Successes:
207207
/// {:a 1} => Value::PersistentListMap {PersistentListMap { MapEntry { :a, 1} .. ]})
208208
pub fn try_read_map(input: &str) -> IResult<&str, Value> {
@@ -228,7 +228,7 @@ pub fn try_read_map(input: &str) -> IResult<&str, Value> {
228228
}
229229

230230
// @TODO use nom functions in place of macro
231-
/// Tries to parse &[u8] into Value::PersistentVector
231+
/// Tries to parse &str into Value::PersistentVector
232232
/// Example Successes:
233233
/// [1 2 3] => Value::PersistentVector(PersistentVector { vals: [Rc(Value::I32(1) ... ]})
234234
/// [1 2 [5 10 15] 3]

0 commit comments

Comments
 (0)