aboutsummaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-04-30 20:47:38 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-04-30 20:47:38 -0400
commitc66946435bc76ed705278dd756eb1abfc41c2e34 (patch)
treef4a842a9c3f1eb5b55bd9c4fa7a61ac382c693bb /api
parentcd7db542748d4ae8262e2fcb4a71c94c87ebf0e7 (diff)
Update wording to remove 'null'
Diffstat (limited to 'api')
-rw-r--r--api/api.md12
-rw-r--r--api/paths.md12
-rw-r--r--api/paths.yaml22
3 files changed, 23 insertions, 23 deletions
diff --git a/api/api.md b/api/api.md
index 527708ad..434dcd55 100644
--- a/api/api.md
+++ b/api/api.md
@@ -2619,13 +2619,13 @@ path | `Path` | The path of the file or directory. | -
Path.by_line : func(path: Path -> func(->Text?)?)
```
-Returns an iterator that can be used to iterate over a file one line at a time, or returns a null value if the file could not be opened.
+Returns an iterator that can be used to iterate over a file one line at a time, or returns none if the file could not be opened.
Argument | Type | Description | Default
---------|------|-------------|---------
path | `Path` | The path of the file. | -
-**Return:** An iterator that can be used to get lines from a file one at a time or a null value if the file couldn't be read.
+**Return:** An iterator that can be used to get lines from a file one at a time or none if the file couldn't be read.
**Example:**
@@ -3178,13 +3178,13 @@ path | `Path` | The path of the file or directory. | -
Path.read : func(path: Path -> Text?)
```
-Reads the contents of the file at the specified path or a null value if the file could not be read.
+Reads the contents of the file at the specified path or none if the file could not be read.
Argument | Type | Description | Default
---------|------|-------------|---------
path | `Path` | The path of the file to read. | -
-**Return:** The contents of the file. If the file could not be read, a null value will be returned. If the file can be read, but is not valid UTF8 data, an error will be raised.
+**Return:** The contents of the file. If the file could not be read, none will be returned. If the file can be read, but is not valid UTF8 data, an error will be raised.
**Example:**
@@ -3202,14 +3202,14 @@ path | `Path` | The path of the file to read. | -
Path.read_bytes : func(path: Path, limit: Int? = none -> [Byte]?)
```
-Reads the contents of the file at the specified path or a null value if the file could not be read.
+Reads the contents of the file at the specified path or none if the file could not be read.
Argument | Type | Description | Default
---------|------|-------------|---------
path | `Path` | The path of the file to read. | -
limit | `Int?` | A limit to how many bytes should be read. | `none`
-**Return:** The byte contents of the file. If the file cannot be read, a null value will be returned.
+**Return:** The byte contents of the file. If the file cannot be read, none will be returned.
**Example:**
diff --git a/api/paths.md b/api/paths.md
index 68f413ef..7929e71f 100644
--- a/api/paths.md
+++ b/api/paths.md
@@ -98,13 +98,13 @@ path | `Path` | The path of the file or directory. | -
Path.by_line : func(path: Path -> func(->Text?)?)
```
-Returns an iterator that can be used to iterate over a file one line at a time, or returns a null value if the file could not be opened.
+Returns an iterator that can be used to iterate over a file one line at a time, or returns none if the file could not be opened.
Argument | Type | Description | Default
---------|------|-------------|---------
path | `Path` | The path of the file. | -
-**Return:** An iterator that can be used to get lines from a file one at a time or a null value if the file couldn't be read.
+**Return:** An iterator that can be used to get lines from a file one at a time or none if the file couldn't be read.
**Example:**
@@ -657,13 +657,13 @@ path | `Path` | The path of the file or directory. | -
Path.read : func(path: Path -> Text?)
```
-Reads the contents of the file at the specified path or a null value if the file could not be read.
+Reads the contents of the file at the specified path or none if the file could not be read.
Argument | Type | Description | Default
---------|------|-------------|---------
path | `Path` | The path of the file to read. | -
-**Return:** The contents of the file. If the file could not be read, a null value will be returned. If the file can be read, but is not valid UTF8 data, an error will be raised.
+**Return:** The contents of the file. If the file could not be read, none will be returned. If the file can be read, but is not valid UTF8 data, an error will be raised.
**Example:**
@@ -681,14 +681,14 @@ path | `Path` | The path of the file to read. | -
Path.read_bytes : func(path: Path, limit: Int? = none -> [Byte]?)
```
-Reads the contents of the file at the specified path or a null value if the file could not be read.
+Reads the contents of the file at the specified path or none if the file could not be read.
Argument | Type | Description | Default
---------|------|-------------|---------
path | `Path` | The path of the file to read. | -
limit | `Int?` | A limit to how many bytes should be read. | `none`
-**Return:** The byte contents of the file. If the file cannot be read, a null value will be returned.
+**Return:** The byte contents of the file. If the file cannot be read, none will be returned.
**Example:**
diff --git a/api/paths.yaml b/api/paths.yaml
index f33b7a77..5efae599 100644
--- a/api/paths.yaml
+++ b/api/paths.yaml
@@ -96,12 +96,12 @@ Path.by_line:
short: iterate by line
description: >
Returns an iterator that can be used to iterate over a file one line at a time,
- or returns a null value if the file could not be opened.
+ or returns none if the file could not be opened.
return:
type: 'func(->Text?)?'
description: >
- An iterator that can be used to get lines from a file one at a time or a null
- value if the file couldn't be read.
+ An iterator that can be used to get lines from a file one at a time or
+ none if the file couldn't be read.
args:
path:
type: 'Path'
@@ -619,14 +619,14 @@ Path.parent:
Path.read:
short: read file contents
description: >
- Reads the contents of the file at the specified path or a null value if the
- file could not be read.
+ Reads the contents of the file at the specified path or none if the file
+ could not be read.
return:
type: 'Text?'
description: >
- The contents of the file. If the file could not be read, a null value will be
- returned. If the file can be read, but is not valid UTF8 data, an error will be
- raised.
+ The contents of the file. If the file could not be read, none will be
+ returned. If the file can be read, but is not valid UTF8 data, an error
+ will be raised.
args:
path:
type: 'Path'
@@ -642,12 +642,12 @@ Path.read:
Path.read_bytes:
short: read file contents as bytes
description: >
- Reads the contents of the file at the specified path or a null value if the
- file could not be read.
+ Reads the contents of the file at the specified path or none if the file
+ could not be read.
return:
type: '[Byte]?'
description: >
- The byte contents of the file. If the file cannot be read, a null value will be
+ The byte contents of the file. If the file cannot be read, none will be
returned.
args:
path: