Document :by_line()

This commit is contained in:
Bruce Hill 2024-09-09 22:18:46 -04:00
parent d356309023
commit 89234e34e2

View File

@ -88,6 +88,31 @@ The base name of the file or directory.
---
### `by_line`
**Description:**
Returns an iterator that can be used to iterate over a file one line at a time.
**Usage:**
```markdown
by_line(path: Path) -> func()->NextLine
```
**Parameters:**
- `path`: The path of the file.
**Returns:**
An iterator that can be used to get lines from a file one at a time.
**Example:**
```markdown
for line in (/dev/stdin):by_line():
say(line:upper())
```
---
### `children`
**Description:**