X-Git-Url: https://git.rrq.au/?a=blobdiff_plain;f=adoc%2Fp_stream_nchars.adoc;h=0a9e85ae307458f79d23d6eeb40d848fe0dbac40;hb=a0aa0a5825ce306120666fd5425308a8ec9314f8;hp=c56b88a6886d6533b188b5c4aecf77fea939e6a2;hpb=b7da3f7bbd1cb10241163abdb950472e539e796d;p=rrq%2Frrqforth.git

diff --git a/adoc/p_stream_nchars.adoc b/adoc/p_stream_nchars.adoc
index c56b88a..0a9e85a 100644
--- a/adoc/p_stream_nchars.adoc
+++ b/adoc/p_stream_nchars.adoc
@@ -1,9 +1,14 @@
+// stdio.asm:	WORD p_stream_nchars,'STREAM-NCHARS',fasm
+
 anchor:p_stream_nchars[]
 
-Word: STREAM-NCHARS
--------------------
+=== Word: STREAM-NCHARS
+....
+Data stack: ( stream -- n )
+....
 
-----
-stdio.asm:	WORD p_stream_nchars,'STREAM-NCHARS',fasm
-----
+"STREAM-NCHARS" is a function word that scans ahead in the stream
+buffer for the next non-whitespace character, and returns its position
+relative to the end of the buffer. This is done without changing the
+stream (or filling it by reading the backing file).