]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Docstring changes: Specify exceptions raised
authorAndrew M. Kuchling <amk@amk.ca>
Sat, 4 Oct 2008 01:04:24 +0000 (01:04 +0000)
committerAndrew M. Kuchling <amk@amk.ca>
Sat, 4 Oct 2008 01:04:24 +0000 (01:04 +0000)
Objects/listobject.c

index 10f2c5da259b83a00cca77a3f26819643ca4be2c..e8379e181bb83f713ac0b5f7824a0c24fe83d657 100644 (file)
@@ -2459,11 +2459,14 @@ PyDoc_STRVAR(extend_doc,
 PyDoc_STRVAR(insert_doc,
 "L.insert(index, object) -- insert object before index");
 PyDoc_STRVAR(pop_doc,
-"L.pop([index]) -> item -- remove and return item at index (default last)");
+"L.pop([index]) -> item -- remove and return item at index (default last).\n"
+"Raises IndexError if list is empty or index is out of range.");
 PyDoc_STRVAR(remove_doc,
-"L.remove(value) -- remove first occurrence of value");
+"L.remove(value) -- remove first occurrence of value.\n"
+"Raises ValueError if the value is not present.");
 PyDoc_STRVAR(index_doc,
-"L.index(value, [start, [stop]]) -> integer -- return first index of value");
+"L.index(value, [start, [stop]]) -> integer -- return first index of value.\n"
+"Raises ValueError if the value is not present.");
 PyDoc_STRVAR(count_doc,
 "L.count(value) -> integer -- return number of occurrences of value");
 PyDoc_STRVAR(reverse_doc,