emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/stream ec86243 24/36: Some details in the documentation


From: Stefan Monnier
Subject: [elpa] externals/stream ec86243 24/36: Some details in the documentation
Date: Tue, 1 Dec 2020 17:22:51 -0500 (EST)

branch: externals/stream
commit ec86243155ae080a94a73f5cb694eb6db24e45e9
Author: Michael Heerdegen <michael_heerdegen@web.de>
Commit: Michael Heerdegen <michael_heerdegen@web.de>

    Some details in the documentation
---
 stream.el | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/stream.el b/stream.el
index 9a7f664..afb739f 100644
--- a/stream.el
+++ b/stream.el
@@ -110,7 +110,7 @@ SEQ can be a list, vector or string."
 (cl-defmethod stream ((buffer buffer) &optional pos)
   "Return a stream of the characters of the buffer BUFFER.
 BUFFER may be a buffer or a string (buffer name).
-The sequence starts at POS if non-nil, 1 otherwise."
+The sequence starts at POS if non-nil, `point-min' otherwise."
   (with-current-buffer buffer
     (unless pos (setq pos (point-min)))
     (if (>= pos (point-max))
@@ -166,11 +166,12 @@ range is infinite."
   (list stream--identifier (thunk-delay nil)))
 
 (defun stream-empty-p (stream)
-  "Return non-nil is STREAM is empty, nil otherwise."
+  "Return non-nil if STREAM is empty, nil otherwise."
   (null (thunk-force (cadr stream))))
 
 (defun stream-first (stream)
-  "Return the first element of STREAM."
+  "Return the first element of STREAM.
+Return nil if STREAM is empty."
   (car (thunk-force (cadr stream))))
 
 (defun stream-rest (stream)



reply via email to

[Prev in Thread] Current Thread [Next in Thread]