[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master af31a84: Some details in the documentation
From: |
Michael Heerdegen |
Subject: |
[elpa] master af31a84: Some details in the documentation |
Date: |
Mon, 17 Oct 2016 14:59:20 +0000 (UTC) |
branch: master
commit af31a84fb95376af89b3f914f92e8c6135cbe89a
Author: Michael Heerdegen <address@hidden>
Commit: Michael Heerdegen <address@hidden>
Some details in the documentation
---
packages/stream/stream.el | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/packages/stream/stream.el b/packages/stream/stream.el
index 9a7f664..afb739f 100644
--- a/packages/stream/stream.el
+++ b/packages/stream/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)
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] master af31a84: Some details in the documentation,
Michael Heerdegen <=