Skip to content

Commit

Permalink
bpo-20408: Fix memoryview() signature in docs (GH-24431)
Browse files Browse the repository at this point in the history
(cherry picked from commit d18e5da)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
  • Loading branch information
miss-islington and felixxm committed May 25, 2021
1 parent 3af61a7 commit 8accb8c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion Doc/library/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,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
Expand Down
15 changes: 7 additions & 8 deletions Doc/library/stdtypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3609,17 +3609,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
Expand Down

0 comments on commit 8accb8c

Please sign in to comment.