summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpommicket <pommicket@gmail.com>2025-09-07 23:51:04 -0400
committerpommicket <pommicket@gmail.com>2025-09-07 23:51:04 -0400
commit21e1a3e05e5f687b31aa69e7d628c050c8876673 (patch)
tree775115ffd8afb9123e039d8d0f31d2276a4334ac
parent37f4664a3d363f72df89e19947f22548a7df0963 (diff)
Clarify read_until_lf docs
-rw-r--r--src/lib.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 44911c5..7815571 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -279,8 +279,8 @@ fn parse_list(_location: &Location, _string: &str) -> Vec<String> {
pub trait Read {
/// Read up to the next line feed (or EOF), not including the line feed itself.
///
- /// Puts the line in `line` and returns `Ok(true)`, if the end of file has been reached,
- /// `line` is unmodified and `Ok(false)` is returned.
+ /// Puts the line in `line` and returns `Ok(true)`.
+ /// If the end of file has been reached, `line` is unmodified and `Ok(false)` is returned.
///
/// You don't need to check for valid UTF-8 here — that is already done in the code which uses
/// this trait.