summaryrefslogtreecommitdiffstats
path: root/Objects/rangeobject.c
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2015-04-22 13:16:07 (GMT)
committerBenjamin Peterson <benjamin@python.org>2015-04-22 13:16:07 (GMT)
commitac22c6b923d12e2b9069324c82a95d2353d0cd28 (patch)
tree0959e4fd59d4d02ff6e8d76a1d760629685c839a /Objects/rangeobject.c
parent3af7a38c616869b1d195add43b43e8af118e6a31 (diff)
downloadcpython-ac22c6b923d12e2b9069324c82a95d2353d0cd28.zip
cpython-ac22c6b923d12e2b9069324c82a95d2353d0cd28.tar.gz
cpython-ac22c6b923d12e2b9069324c82a95d2353d0cd28.tar.bz2
improved range docstring (closes #22785)
Patch by Ned Batchelder.
Diffstat (limited to 'Objects/rangeobject.c')
-rw-r--r--Objects/rangeobject.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/Objects/rangeobject.c b/Objects/rangeobject.c
index 7e6c733..ca66a45 100644
--- a/Objects/rangeobject.c
+++ b/Objects/rangeobject.c
@@ -139,7 +139,11 @@ PyDoc_STRVAR(range_doc,
"range(stop) -> range object\n\
range(start, stop[, step]) -> range object\n\
\n\
-Return a sequence of numbers from start to stop by step.");
+Return an object that produces a sequence of integers from start (inclusive)\n\
+to stop (exclusive) by step. range(i, j) produces i, i+1, i+2, ..., j-1.\n\
+start defaults to 0, and stop is omitted! range(4) produces 0, 1, 2, 3.\n\
+These are exactly the valid indices for a list of 4 elements.\n\
+When step is given, it specifies the increment (or decrement).");
static void
range_dealloc(rangeobject *r)