Nicer wording in LazyList.index docstring

`other`?! I must have been high or something
DasIch · Mar 12, 2011 · e24b8d5 · e24b8d5
1 parent 9f5621d
commit e24b8d5
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/brownie/datastructures/sequences.py b/brownie/datastructures/sequences.py
@@ -203,14 +203,16 @@ def count(self, object):
         """
         return self._collected_data.count(object)
 
-    def index(self, other):
+    def index(self, object):
         """
-        Returns first index of the `other` in list
+        Returns first index of the `object` in list
+
+        This method exhausts the internal iterator up until the given `object`.
         """
         for i, obj in enumerate(self):
-            if obj == other:
+            if obj == object:
                 return i
-        raise ValueError('%s not in LazyList' % other)
+        raise ValueError('%s not in LazyList' % object)
 
     def __getitem__(self, i):
         """

diff --git a/docs/api/datastructures.rst b/docs/api/datastructures.rst
@@ -59,7 +59,7 @@ Sequences
 ---------
 
 .. autoclass:: LazyList
-   :members: factory, count, insert, pop, remove, reverse, sort
+   :members: factory, count, index, insert, pop, remove, reverse, sort
 
 .. autoclass:: CombinedSequence
    :members: