Skip to content

Commit f711804

Browse files
committed
DOC: Move read-only note about buffers to the "buffer" argument docs
1 parent b35bf96 commit f711804

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

src/pa_ringbuffer.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,15 @@ class _RingBufferBase(object):
7171
Python thread to another Python thread. For this, the `queue.Queue`
7272
class from the standard library can be used.
7373
74-
Note that if you pass a read-only buffer object, you still get a writable
75-
RingBuffer; it is your responsibility not to write there if the original
76-
buffer doesn’t expect you to.
77-
7874
:param elementsize: The size of a single data element in bytes.
7975
:type elementsize: int
8076
:param size: The number of elements in the buffer (must be a power
8177
of 2). Can be omitted if a pre-allocated buffer is passed.
8278
:type size: int
8379
:param buffer: optional pre-allocated buffer to use with RingBuffer.
80+
Note that if you pass a read-only buffer object, you still get a
81+
writable RingBuffer; it is your responsibility not to write
82+
there if the original buffer doesn’t expect you to.
8483
:type buffer: buffer
8584
8685
"""

0 commit comments

Comments
 (0)