Skip to content

Commit 7fcc112

Browse files
committed
DOC: Remove a few return types
1 parent 1132ac3 commit 7fcc112

File tree

1 file changed

+2
-14
lines changed

1 file changed

+2
-14
lines changed

src/pa_ringbuffer.py

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,7 @@ def write(self, data, size=-1):
138138
:type data: CData pointer or buffer or bytes
139139
:param size: The number of elements to be written.
140140
:type size: int, optional
141-
142141
:returns: The number of elements written.
143-
:rtype: int
144142
145143
"""
146144
try:
@@ -162,10 +160,8 @@ def read(self, size=-1):
162160
:param size: The number of elements to be read.
163161
If not specified, all available elements are read.
164162
:type size: int, optional
165-
166163
:returns: A new buffer containing the read data.
167164
Its size may be less than the requested *size*.
168-
:rtype: buffer
169165
170166
"""
171167
if size < 0:
@@ -182,10 +178,8 @@ def readinto(self, data):
182178
183179
:param data: The memory where the data should be stored.
184180
:type data: CData pointer or buffer
185-
186181
:returns: The number of elements read, which may be less than
187182
the size of *data*.
188-
:rtype: int
189183
190184
"""
191185
try:
@@ -205,13 +199,12 @@ def get_write_buffers(self, size):
205199
206200
:param size: The number of elements desired.
207201
:type size: int
208-
209202
:returns:
210203
* The room available to be written or the given *size*,
211204
whichever is smaller.
212205
* The first buffer.
213206
* The second buffer.
214-
:rtype: (int, buffer, buffer)
207+
:rtype: tuple (int, buffer, buffer)
215208
216209
"""
217210
ptr1 = self._ffi.new('void**')
@@ -228,9 +221,7 @@ def advance_write_index(self, size):
228221
229222
:param size: The number of elements to advance.
230223
:type size: int
231-
232224
:returns: The new position.
233-
:rtype: int
234225
235226
.. note:: This is only needed when using
236227
:meth:`get_write_buffers`, the method :meth:`write` takes
@@ -247,13 +238,12 @@ def get_read_buffers(self, size):
247238
248239
:param size: The number of elements desired.
249240
:type size: int
250-
251241
:returns:
252242
* The number of elements available for reading (which might
253243
be less than the requested *size*).
254244
* The first buffer.
255245
* The second buffer.
256-
:rtype: (int, buffer, buffer)
246+
:rtype: tuple (int, buffer, buffer)
257247
258248
"""
259249
ptr1 = self._ffi.new('void**')
@@ -270,9 +260,7 @@ def advance_read_index(self, size):
270260
271261
:param size: The number of elements to advance.
272262
:type size: int
273-
274263
:returns: The new position.
275-
:rtype: int
276264
277265
.. note:: This is only needed when using
278266
:meth:`get_read_buffers`, the methods :meth:`read` and

0 commit comments

Comments
 (0)