Rename warnings to notes

This commit is contained in:
Nigel Tao committed 2020-01-05 13:15:00 +11:00
1 parent 0319777cce
commit 0fa32bd09f
13 files changed
+82 -86

No files matched your search

+1
View File
@@ -3,6 +3,7 @@
## Work In Progress
- Renamed warnings to notes.
- Made `wuffs_base__status` a struct.
+5 -5
View File
@@ -5,7 +5,7 @@ involving [I/O](/doc/note/io-input-output.md) - return a status value. There
are four categories:
- OK: the request was completed, successfully.
- Warnings: the request was completed, unsuccessfully.
- Notes: the request was completed, unsuccessfully.
- Suspensions: the request was not completed, but can be re-tried.
- Errors: the request was not completed, permanently.
@@ -18,12 +18,12 @@ When a method returns a suspension, the suspended
again. However, calling any other public coroutine method, while already
suspended, will lead to an `"#interleaved coroutine calls"` error.
Otherwise, the call was complete. 'Warning' or 'unsuccessful' doesn't
Otherwise, the call was complete. 'Unsuccessful' (i.e. a note) doesn't
necessarily mean 'bad' or something to avoid, only that something occurred
other than the typical outcome. For example, when decoding an animated image,
without knowing the number of frames beforehand, a call to "decode the next
frame" could return OK, if there was a next frame, or an `"@end of data"`
warning, if there wasn't.
frame" could return OK, if there was a next frame, or an `"@end of data"` note,
if there wasn't.
## Statuses are Strings
@@ -60,7 +60,7 @@ information such as a source filename.
The first byte of the string message gives the category. For example, `"#bad
receiver"` is an error and `"$short read"` is a suspension:
- `'@'` means a warning.
- `'@'` means a note.
- `'$'` means a suspension.
- `'#'` means an error.
+1 -1
View File
@@ -31,7 +31,7 @@ wuffs_base__pixel_buffer pb = etc;
while (true) {
wuffs_base__frame_config fc;
status = wuffs_gif__decoder__decode_frame_config(dec, &fc, &src);
if (status == wuffs_base__warning__end_of_data) {
if (status == wuffs_base__note__end_of_data) {
break;
}
// Ditto re error checking.