Skip to content

Commit 987bd27

Browse files
emmatypinghugovk
andauthored
Don't reference self when referring to items
Co-authored-by: Hugo van Kemenade <[email protected]>
1 parent 5eb5efc commit 987bd27

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Doc/library/compression.zstd.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Reading and writing compressed files
102102
When opening a file for reading, the *options* argument can be a dictionary
103103
providing advanced decompression parameters, see
104104
:class:`DecompressionParameter` for detailed information about supported
105-
parameters. The *zstd_dict* argument is a :class:`ZstdDict` instance to be
105+
parameters. The *zstd_dict* argument is a :class:`!ZstdDict` instance to be
106106
used during decompression. When opening a file for reading, the *level*
107107
argument should not be used.
108108

@@ -111,13 +111,13 @@ Reading and writing compressed files
111111
:class:`CompressionParameter` for detailed information about supported
112112
parameters. The *level* argument is the compression level to use when
113113
writing compressed data. Only one of *level* or *options* may be passed. The
114-
*zstd_dict* argument is a :class:`ZstdDict` instance to be used during
114+
*zstd_dict* argument is a :class:`!ZstdDict` instance to be used during
115115
compression.
116116

117117
When opening a file for writing, the *options*, *zstd_dict* and *level*
118118
arguments have the same meanings as for :class:`ZstdCompressor`.
119119

120-
:class:`ZstdFile` supports all the members specified by
120+
:class:`!ZstdFile` supports all the members specified by
121121
:class:`io.BufferedIOBase`, except for :meth:`~io.BufferedIOBase.detach`
122122
and :meth:`~io.IOBase.truncate`.
123123
Iteration and the :keyword:`with` statement are supported.
@@ -231,7 +231,7 @@ Compressing and decompressing data in memory
231231
Compress *data* (a :term:`bytes-like object`), returning a :class:`bytes`
232232
object if possible, or an empty byte string otherwise. Some of *data* may
233233
be buffered internally, for use in later calls to
234-
:meth:`~.compress` and :meth:`~.flush`. The
234+
:meth:`!compress` and :meth:`~.flush`. The
235235
returned data should be concatenated with the output of any previous calls
236236
to :meth:`~.compress`.
237237

@@ -273,15 +273,15 @@ Compressing and decompressing data in memory
273273
compressed frames, unlike the :func:`decompress` function and
274274
:class:`ZstdFile` class. To decompress a multi-frame input, you should
275275
use :func:`decompress`, :class:`ZstdFile` if working with a
276-
:term:`file object`, or multiple :class:`ZstdDecompressor` instances.
276+
:term:`file object`, or multiple :class:`!ZstdDecompressor` instances.
277277

278278
.. method:: decompress(data, max_length=-1)
279279

280280
Decompress *data* (a :term:`bytes-like object`), returning
281281
uncompressed data as bytes. Some of *data* may be buffered
282-
internally, for use in later calls to :meth:`~.decompress`.
282+
internally, for use in later calls to :meth:`!decompress`.
283283
The returned data should be concatenated with the output of any previous
284-
calls to :meth:`~.decompress`.
284+
calls to :meth:`!decompress`.
285285

286286
If *max_length* is non-negative, returns at most *max_length*
287287
bytes of decompressed data. If this limit is reached and further
@@ -395,7 +395,7 @@ Zstandard dictionaries
395395

396396
.. note::
397397

398-
The meaning of ``0`` for :attr:`ZstdDict.dict_id` is different from
398+
The meaning of ``0`` for :attr:`!ZstdDict.dict_id` is different from
399399
the ``dictionary_id`` argument to the :func:`get_frame_info`
400400
function.
401401

@@ -598,7 +598,7 @@ Advanced parameter control
598598
.. attribute:: nb_workers
599599

600600
Select how many threads will be spawned to compress in parallel. When
601-
:attr:`~.nb_workers` >= 1, enables multi-threaded compression, 1
601+
:attr:`!nb_workers` >= 1, enables multi-threaded compression, 1
602602
means "1-thread multi-threaded mode". More workers improve speed, but
603603
also increase memory usage and slightly reduce compression ratio.
604604

0 commit comments

Comments
 (0)