about summary refs log tree commit diff stats
path: root/subx/Readme.md
diff options
context:
space:
mode:
authorKartik Agaram <vc@akkartik.com>2019-05-02 23:32:51 -0700
committerKartik Agaram <vc@akkartik.com>2019-05-02 23:32:51 -0700
commitf2cd405d04cd904bf1ed4d5ddf4916234c0509f5 (patch)
treeaacf72ab67c49c3ac2a2d6425924ef0999ebfe8d /subx/Readme.md
parent6e131cefe2cdf9d83bd0727fa3ca97a2ec3b2d3f (diff)
downloadmu-f2cd405d04cd904bf1ed4d5ddf4916234c0509f5.tar.gz
standardize function names
Operations on buffered-file now always include the word 'buffered'. More
verbose, but hopefully this highlights holes in the library.
Diffstat (limited to 'subx/Readme.md')
-rw-r--r--subx/Readme.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/subx/Readme.md b/subx/Readme.md
index e8e4ad6d..a27bf0f4 100644
--- a/subx/Readme.md
+++ b/subx/Readme.md
@@ -627,16 +627,18 @@ allocated memory for it.)_
   - Can also be used to cat one stream into another.
   - Will abort the entire program if there isn't enough room.
 * `write-buffered`: string -> buffered-file
-* `write-slice`: slice -> buffered-file
+* `write-slice-buffered`: slice -> buffered-file
 * `flush`: buffered-file
-* `print-byte`:  buffered-file, int
+* `write-byte-buffered`: int -> buffered-file
+* `print-byte-buffered`: int -> buffered-file
+  - textual representation in hex
 
 #### reading from disk
 * `read`: file -> stream
   - Can also be used to cat one stream into another.
   - Will silently stop reading when destination runs out of space.
-* `read-byte`: buffered-file -> byte
-* `read-line`: buffered-file -> stream
+* `read-byte-buffered`: buffered-file -> byte
+* `read-line-buffered`: buffered-file -> stream
   - Will abort the entire program if there isn't enough room.
 
 #### non-IO operations on streams