major touch-up into presentable form

[rrq/rrqforth.git] / adoc / p_stream_nchars.adoc

diff --git a/adoc/p_stream_nchars.adoc b/adoc/p_stream_nchars.adoc
index c56b88a6886d6533b188b5c4aecf77fea939e6a2..0a9e85ae307458f79d23d6eeb40d848fe0dbac40 100644 (file)
--- 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).