Skip to content

Commit 4ea1fe7

Browse files
committed
DOC: switch default_role from 'any' to 'py:obj'
1 parent f37a6ef commit 4ea1fe7

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

doc/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
except Exception:
5656
today = '<unknown date>'
5757

58-
default_role = 'any'
58+
default_role = 'py:obj'
5959

6060
nitpicky = True
6161

sounddevice.py

+14-14
Original file line numberDiff line numberDiff line change
@@ -742,8 +742,8 @@ def __init__(self, kind, samplerate=None, blocksize=None, device=None,
742742
`RawStream`, `RawInputStream` and `RawOutputStream` instead.
743743
744744
This class has the same properties and methods as `Stream`,
745-
except for `read_available`/:meth:`~Stream.read` and
746-
`write_available`/:meth:`~Stream.write`.
745+
except for `~Stream.read_available`/`~Stream.read()` and
746+
`~Stream.write_available`/`~Stream.write()`.
747747
748748
It can be created with the same parameters as `Stream`,
749749
except that there are three additional parameters
@@ -1176,7 +1176,7 @@ def __init__(self, samplerate=None, blocksize=None,
11761176
"""PortAudio input stream (using buffer objects).
11771177
11781178
This is the same as `InputStream`, except that the *callback*
1179-
function and :meth:`~RawStream.read` work on plain Python buffer
1179+
function and `~RawStream.read()` work on plain Python buffer
11801180
objects instead of on NumPy arrays.
11811181
NumPy is not necessary for using this.
11821182
@@ -1234,7 +1234,7 @@ def read(self, frames):
12341234
samples in the format specified by the *dtype* parameter
12351235
used to open the stream, and the number of channels
12361236
specified by *channels*.
1237-
See also `samplesize`.
1237+
See also `~Stream.samplesize`.
12381238
overflowed : bool
12391239
See `Stream.read()`.
12401240
@@ -1262,7 +1262,7 @@ def __init__(self, samplerate=None, blocksize=None,
12621262
"""PortAudio output stream (using buffer objects).
12631263
12641264
This is the same as `OutputStream`, except that the *callback*
1265-
function and :meth:`~RawStream.write` work on plain Python
1265+
function and `~RawStream.write()` work on plain Python
12661266
buffer objects instead of on NumPy arrays.
12671267
NumPy is not necessary for using this.
12681268
@@ -1317,7 +1317,7 @@ def write(self, data):
13171317
*channels*. The length of the buffer is not constrained to
13181318
a specific range, however high performance applications will
13191319
want to match this parameter to the *blocksize* parameter
1320-
used when opening the stream. See also `samplesize`.
1320+
used when opening the stream. See also `~Stream.samplesize`.
13211321
13221322
Returns
13231323
-------
@@ -1378,7 +1378,7 @@ def __init__(self, samplerate=None, blocksize=None,
13781378
``'uint8'``), this also supports ``'int24'``, i.e.
13791379
packed 24 bit format.
13801380
The default value can be changed with `default.dtype`.
1381-
See also `samplesize`.
1381+
See also `~Stream.samplesize`.
13821382
callback : callable
13831383
User-supplied function to consume, process or generate audio
13841384
data in response to requests from an active stream.
@@ -1413,7 +1413,7 @@ def __init__(self, samplerate=None, blocksize=None,
14131413
"""PortAudio input stream (using NumPy).
14141414
14151415
This has the same methods and attributes as `Stream`, except
1416-
:meth:`~Stream.write` and `write_available`.
1416+
`~Stream.write()` and `~Stream.write_available`.
14171417
Furthermore, the stream callback is expected to have a different
14181418
signature (see below).
14191419
@@ -1488,7 +1488,7 @@ def __init__(self, samplerate=None, blocksize=None,
14881488
"""PortAudio output stream (using NumPy).
14891489
14901490
This has the same methods and attributes as `Stream`, except
1491-
:meth:`~Stream.read` and `read_available`.
1491+
`~Stream.read()` and `~Stream.read_available`.
14921492
Furthermore, the stream callback is expected to have a different
14931493
signature (see below).
14941494
@@ -2110,7 +2110,7 @@ class default:
21102110
21112111
See Also
21122112
--------
2113-
:func:`query_devices`
2113+
`query_devices()`
21142114
21152115
"""
21162116
channels = _default_channels = None, None
@@ -2120,7 +2120,7 @@ class default:
21202120
21212121
See Also
21222122
--------
2123-
:func:`query_devices`
2123+
`query_devices()`
21242124
21252125
"""
21262126
dtype = _default_dtype = 'float32', 'float32'
@@ -2152,7 +2152,7 @@ class default:
21522152
21532153
See Also
21542154
--------
2155-
:func:`query_devices`
2155+
`query_devices()`
21562156
21572157
"""
21582158
blocksize = _lib.paFramesPerBufferUnspecified
@@ -2272,7 +2272,7 @@ class CallbackStop(Exception):
22722272
22732273
See Also
22742274
--------
2275-
CallbackAbort, :meth:`Stream.stop`, Stream
2275+
CallbackAbort, `Stream.stop()`, Stream
22762276
22772277
"""
22782278

@@ -2285,7 +2285,7 @@ class CallbackAbort(Exception):
22852285
22862286
See Also
22872287
--------
2288-
CallbackStop, :meth:`Stream.abort`, Stream
2288+
CallbackStop, `Stream.abort()`, Stream
22892289
22902290
"""
22912291

0 commit comments

Comments
 (0)