branch: elpa/isl
commit 91c3ea51bdd0040389ae88124001bd267ae8fc11
Author: Thierry Volpiatto <[email protected]>
Commit: Thierry Volpiatto <[email protected]>
Docstring only
---
isl.el | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/isl.el b/isl.el
index 41b332555a3..7d6a9950e77 100644
--- a/isl.el
+++ b/isl.el
@@ -788,7 +788,14 @@ all align operations you have to exit with RET."
;;; Iterators
;;
(oclosure-define isl-iterator
- "Provide iterator for isl navigation."
+ "Provide iterator for isl navigation.
+SEQ is the main list where the iterator is bound to, it is modified
+only when changing direction.
+TMP-SEQ is bound to SEQ and modified each time the iterator is called.
+CHANGING-DIRECTION tells the iterator we want to change direction.
+ELEMENT refers to the last element yielded.
+DIRECTION refers to the direction we are currently using, left or right.
+All slots are mutables."
(seq :type 'list :mutable t)
(tmp-seq :type 'list :mutable t)
(changing-direction :type 'boolean :mutable t)
