mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 10:50:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

gh-100989: Improve the accuracy of collections.deque docstrings (#100990)

Browse source 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
This commit is contained in:
Timo Ludwig 2023-03-22 12:46:58 +01:00 • committed by GitHub
parent c24f1f1e87
commit c74073657e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

37
Modules/_collectionsmodule.c
View file

@ -910,7 +910,9 @@ deque_rotate(dequeobject *deque, PyObject *const *args, Py_ssize_t nargs)
} }
PyDoc_STRVAR(rotate_doc, PyDoc_STRVAR(rotate_doc,
"Rotate the deque n steps to the right (default n=1). If n is negative, rotates left."); "rotate(n)\n\n"
"Rotate the deque *n* steps to the right (default ``n=1``). "
"If *n* is negative, rotates left.");
static PyObject * static PyObject *
deque_reverse(dequeobject *deque, PyObject *unused) deque_reverse(dequeobject *deque, PyObject *unused)
@ -951,7 +953,8 @@ deque_reverse(dequeobject *deque, PyObject *unused)
} }
PyDoc_STRVAR(reverse_doc, PyDoc_STRVAR(reverse_doc,
"D.reverse() -- reverse *IN PLACE*"); "reverse()\n\n"
"Reverse the elements of the deque *IN PLACE*.");
static PyObject * static PyObject *
deque_count(dequeobject *deque, PyObject *v) deque_count(dequeobject *deque, PyObject *v)
@ -990,7 +993,8 @@ deque_count(dequeobject *deque, PyObject *v)
} }
PyDoc_STRVAR(count_doc, PyDoc_STRVAR(count_doc,
"D.count(value) -> integer -- return number of occurrences of value"); "count(x) -> int\n\n"
"Count the number of deque elements equal to *x*.");
static int static int
deque_contains(dequeobject *deque, PyObject *v) deque_contains(dequeobject *deque, PyObject *v)
@ -1098,8 +1102,10 @@ deque_index(dequeobject *deque, PyObject *const *args, Py_ssize_t nargs)
} }
PyDoc_STRVAR(index_doc, PyDoc_STRVAR(index_doc,
"D.index(value, [start, [stop]]) -> integer -- return first index of value.\n" "index(x, [start, [stop]]) -> int\n\n"
"Raises ValueError if the value is not present."); "Return the position of *x* in the deque "
"(at or after index *start* and before index *stop*). "
"Returns the first match or raises a ValueError if not found.");
/* insert(), remove(), and delitem() are implemented in terms of /* insert(), remove(), and delitem() are implemented in terms of
rotate() for simplicity and reasonable performance near the end rotate() for simplicity and reasonable performance near the end
@ -1144,10 +1150,13 @@ deque_insert(dequeobject *deque, PyObject *const *args, Py_ssize_t nargs)
} }
PyDoc_STRVAR(insert_doc, PyDoc_STRVAR(insert_doc,
"D.insert(index, object) -- insert object before index"); "insert(i, x)\n\n"
"Insert *x* into the deque at position *i*.");
PyDoc_STRVAR(remove_doc, PyDoc_STRVAR(remove_doc,
"D.remove(value) -- remove first occurrence of value."); "remove(x)\n\n"
"Remove the first occurrence of *x*."
"If not found, raises a ValueError.");
static int static int
valid_index(Py_ssize_t i, Py_ssize_t limit) valid_index(Py_ssize_t i, Py_ssize_t limit)
@ -1518,7 +1527,8 @@ deque_sizeof(dequeobject *deque, void *unused)
} }
PyDoc_STRVAR(sizeof_doc, PyDoc_STRVAR(sizeof_doc,
"D.__sizeof__() -- size of D in memory, in bytes"); "__sizeof__() -> int\n\n"
"Size of the deque in memory, in bytes.");
static PyObject * static PyObject *
deque_get_maxlen(dequeobject *deque, void *Py_UNUSED(ignored)) deque_get_maxlen(dequeobject *deque, void *Py_UNUSED(ignored))
@ -1553,7 +1563,8 @@ static PySequenceMethods deque_as_sequence = {
static PyObject *deque_iter(dequeobject *deque); static PyObject *deque_iter(dequeobject *deque);
static PyObject *deque_reviter(dequeobject *deque, PyObject *Py_UNUSED(ignored)); static PyObject *deque_reviter(dequeobject *deque, PyObject *Py_UNUSED(ignored));
PyDoc_STRVAR(reversed_doc, PyDoc_STRVAR(reversed_doc,
"D.__reversed__() -- return a reverse iterator over the deque"); "__reversed__()\n\n"
"Return a reverse iterator over the deque.");
static PyMethodDef deque_methods[] = { static PyMethodDef deque_methods[] = {
{"append", (PyCFunction)deque_append, {"append", (PyCFunction)deque_append,
@ -1598,9 +1609,8 @@ static PyMethodDef deque_methods[] = {
}; };
PyDoc_STRVAR(deque_doc, PyDoc_STRVAR(deque_doc,
"deque([iterable[, maxlen]]) --> deque object\n\ "deque([iterable[, maxlen]]) -> collections.deque\n\n"
\n\ "A list-like sequence optimized for data accesses near its endpoints.");
A list-like sequence optimized for data accesses near its endpoints.");
static PyTypeObject deque_type = { static PyTypeObject deque_type = {
PyVarObject_HEAD_INIT(NULL, 0) PyVarObject_HEAD_INIT(NULL, 0)
@ -1979,7 +1989,8 @@ new_defdict(defdictobject *dd, PyObject *arg)
dd->default_factory ? dd->default_factory : Py_None, arg, NULL); dd->default_factory ? dd->default_factory : Py_None, arg, NULL);
} }
PyDoc_STRVAR(defdict_copy_doc, "D.copy() -> a shallow copy of D."); PyDoc_STRVAR(defdict_copy_doc, "copy() -> collections.deque\n\n"
"A shallow copy of the deque.");
static PyObject * static PyObject *
defdict_copy(defdictobject *dd, PyObject *Py_UNUSED(ignored)) defdict_copy(defdictobject *dd, PyObject *Py_UNUSED(ignored))