@@ -33,7 +33,7 @@ a bug report:
3333 # etc.
3434 ```
3535
36- 2. An explanation of why the current behavior is wrong/not desired, and what you
36+ 2. An explanation of why the current behaviour is wrong/not desired, and what you
3737 expect instead.
3838
39393. Information about the version of Zarr, along with versions of dependencies and the
@@ -82,13 +82,13 @@ Then clone your fork to your local machine::
8282Creating a development environment
8383~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8484
85- To work with the Zarr source code, it is recommended to use ` hatch
86- <https://hatch.pypa.io/latest/index.html> `_ to create a virtual environment and
87- install all Zarr dependencies using the same versions as are used by
88- the core developers and continuous integration services. Assuming you have a Python
89- 3 interpreter already installed, and you have cloned the Zarr source code and your
90- current working directory is the root of the repository, you can do something like
91- the following::
85+ To work with the Zarr source code, it is recommended to use
86+ ` hatch <https://hatch.pypa.io/latest/index.html >`_ to create and manage development
87+ environments. Hatch will automatically install all Zarr dependencies using the same
88+ versions as are used by the core developers and continuous integration services.
89+ Assuming you have a Python 3 interpreter already installed, and you have cloned the
90+ Zarr source code and your current working directory is the root of the repository,
91+ you can do something like the following::
9292
9393 $ pip install hatch
9494 $ hatch env show # list all available environments
@@ -144,6 +144,10 @@ All tests are automatically run via GitHub Actions for every pull
144144request and must pass before code can be accepted. Test coverage is
145145also collected automatically via the Codecov service.
146146
147+ .. note ::
148+ Previous versions of Zarr-Python made extensive use of doctests. These tests were
149+ not maintained during the 3.0 refactor but may be brought back in the future.
150+
147151Code standards - using pre-commit
148152~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149153
@@ -179,8 +183,7 @@ Test coverage
179183 is welcome to bring test coverage back to 100%. See :issue: `2613 ` for more details.
180184
181185Zarr strives to maintain 100% test coverage under the latest Python stable release
182- (currently Python 3.12). Both unit tests and docstring doctests are included when computing
183- coverage. Running::
186+ Both unit tests and docstring doctests are included when computing coverage. Running::
184187
185188 $ hatch env run --env test.py3.12-2.1-optional run-coverage
186189
0 commit comments