Skip to content

Commit 35e35c4

Browse files
committed
correct config docstring
1 parent 390c435 commit 35e35c4

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/zarr/core/config.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@
44
in the registry and then select them in the config.
55
66
Example:
7-
An implementation of the bytes codec in a class `your.module.NewBytesCodec` requires the value of `codecs.bytes`
8-
to be `your.module.NewBytesCodec`.
7+
An implementation of the bytes codec in a class ``your.module.NewBytesCodec`` requires the value of ``codecs.bytes``
8+
to be ``your.module.NewBytesCodec``.
99
10-
```python
10+
.. code-block:: python
1111
from your.module import NewBytesCodec
1212
from zarr.core.config import register_codec, config
1313
1414
register_codec("bytes", NewBytesCodec)
1515
config.set({"codecs.bytes": "your.module.NewBytesCodec"})
16-
```
1716
1817
Donfig can be configured programmatically, by environment variables, or from YAML files in standard locations.
1918
For example, to set the bytes codec via an environment variable:
2019
20+
.. code-block:: bash
2121
export ZARR_CODECS__BYTES="your.module.NewBytesCodec"
2222
2323
For more information, see the Donfig documentation at https://github.com/pytroll/donfig.

0 commit comments

Comments
 (0)