[Python-checkins] bpo-20408: Fix memoryview() signature in docs (GH-24431)
berkerpeksag
webhook-mailer at python.org
Tue May 25 10:30:19 EDT 2021
https://github.com/python/cpython/commit/05f8ad0c745016cd8b5bdbda4336688b80f45fd7
commit: 05f8ad0c745016cd8b5bdbda4336688b80f45fd7
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: berkerpeksag <berker.peksag at gmail.com>
date: 2021-05-25T17:30:00+03:00
summary:
bpo-20408: Fix memoryview() signature in docs (GH-24431)
(cherry picked from commit d18e5dae914b1db49b25ed7729c07a535d1f0c52)
Co-authored-by: Mariusz Felisiak <felisiak.mariusz at gmail.com>
files:
M Doc/library/functions.rst
M Doc/library/stdtypes.rst
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 7d8a669f9e16d..bc55d42fa8605 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1022,7 +1022,7 @@ are always available. They are listed here in alphabetical order.
.. _func-memoryview:
-.. class:: memoryview(obj)
+.. class:: memoryview(object)
:noindex:
Return a "memory view" object created from the given argument. See
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index c4e6b4d1186d0..e34a888639c18 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -3632,17 +3632,16 @@ Memory Views
of an object that supports the :ref:`buffer protocol <bufferobjects>` without
copying.
-.. class:: memoryview(obj)
+.. class:: memoryview(object)
- Create a :class:`memoryview` that references *obj*. *obj* must support the
- buffer protocol. Built-in objects that support the buffer protocol include
- :class:`bytes` and :class:`bytearray`.
+ Create a :class:`memoryview` that references *object*. *object* must
+ support the buffer protocol. Built-in objects that support the buffer
+ protocol include :class:`bytes` and :class:`bytearray`.
A :class:`memoryview` has the notion of an *element*, which is the
- atomic memory unit handled by the originating object *obj*. For many
- simple types such as :class:`bytes` and :class:`bytearray`, an element
- is a single byte, but other types such as :class:`array.array` may have
- bigger elements.
+ atomic memory unit handled by the originating *object*. For many simple
+ types such as :class:`bytes` and :class:`bytearray`, an element is a single
+ byte, but other types such as :class:`array.array` may have bigger elements.
``len(view)`` is equal to the length of :class:`~memoryview.tolist`.
If ``view.ndim = 0``, the length is 1. If ``view.ndim = 1``, the length
More information about the Python-checkins
mailing list