Skip to content

Commit 4452477

Browse files
Documentation cleanup: fix typos, grammar, and naming consistency
Co-authored-by: DimitriPapadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
1 parent e0ddee6 commit 4452477

3 files changed

Lines changed: 21 additions & 23 deletions

File tree

docs/contributing.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Asking for help
99
---------------
1010

1111
If you have a question about how to use NumCodecs, please post your question on
12-
StackOverflow using the `"numcodecs" tag <https://stackoverflow.com/questions/tagged/numcodecs>`_.
12+
Stack Overflow using the `"numcodecs" tag <https://stackoverflow.com/questions/tagged/numcodecs>`_.
1313
If you don't get a response within a day or two, feel free to raise a `GitHub issue
1414
<https://github.com/zarr-developers/numcodecs/issues/new>`_ including a link to your
15-
StackOverflow question. We will try to respond to questions as quickly as possible, but
15+
Stack Overflow question. We will try to respond to questions as quickly as possible, but
1616
please bear in mind that there may be periods where we have limited time to answer
1717
questions due to other commitments.
1818

@@ -148,12 +148,12 @@ docstrings. The simplest way to run the unit tests is to invoke::
148148

149149
$ pytest -v
150150

151-
NumCodecs currently supports Python 6-3.9, so the above command must
151+
NumCodecs currently supports Python 3.11+, so the above command must
152152
succeed before code can be accepted into the main code base.
153153

154-
All tests are automatically run via Travis (Linux) and AppVeyor (Windows) continuous
155-
integration services for every pull request. Tests must pass under both services before
156-
code can be accepted.
154+
All tests are automatically run via GitHub Actions continuous
155+
integration services for every pull request. Tests must pass
156+
before code can be accepted.
157157

158158
Code standards
159159
~~~~~~~~~~~~~~
@@ -167,8 +167,7 @@ Conformance can be checked by running::
167167
Test coverage
168168
~~~~~~~~~~~~~
169169

170-
NumCodecs maintains 100% test coverage under the latest Python stable release (currently
171-
Python 3.9). Both unit tests and docstring doctests are included when computing
170+
NumCodecs maintains 100% test coverage under the latest Python stable release. Both unit tests and docstring doctests are included when computing
172171
coverage. Running ``pytest -v`` will automatically run the test suite with coverage
173172
and produce a coverage report. This should be 100% before code can be accepted into the
174173
main code base.
@@ -182,8 +181,7 @@ Documentation
182181

183182
Docstrings for user-facing classes and functions should follow the `numpydoc
184183
<https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard>`_ standard,
185-
including sections for Parameters and Examples. All examples will be run as doctests
186-
under Python 3.9.
184+
including sections for Parameters and Examples. All examples will be run as doctests.
187185

188186
NumCodecs uses Sphinx for documentation, hosted on readthedocs.org. Documentation is
189187
written in the RestructuredText markup language (.rst files) in the ``docs`` folder.

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Installation
1212

1313
Numcodecs depends on NumPy. It is generally best to `install NumPy
1414
<https://numpy.org/install/>`_ first using whatever method is most
15-
appropriate for you operating system and Python distribution.
15+
appropriate for your operating system and Python distribution.
1616

1717
Install from PyPI::
1818

@@ -51,7 +51,7 @@ and then install in editable mode using `pip`.::
5151
$ pip install -e .[test,msgpack,zfpy]
5252

5353
Note: if you prefer to use the GitHub CLI ``gh`` you will need to append ``-- --recurse-submodules``
54-
to the clone command to everything works properly.
54+
to the clone command to ensure everything works properly.
5555

5656
To verify that Numcodecs has been fully installed (including the Blosc
5757
extension) run the test suite::

docs/release.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Enhancements
4848
Fixes
4949
~~~~~
5050

51-
* Fix ``PCodec.decode()`` to handle numpy arrays by calling ``ensure_bytes`` on input buffers.
51+
* Fix ``PCodec.decode()`` to handle NumPy arrays by calling ``ensure_bytes`` on input buffers.
5252
By :user:`Sam Levang <slowjazz>`, :issue:`756`
5353

5454
Maintenance
@@ -180,7 +180,7 @@ Enhancements
180180
By :user:`Agriya Khetarpal <agriyakhetarpal>`, :issue:`288`.
181181
* Preallocate output buffers and resize directly as needed.
182182
By :user:`John Kirkham <jakirkham>`, :issue:`656`
183-
* ``Checksum32`` is now an abstract base clase, with ``checksum()`` as an abstract method.
183+
* ``Checksum32`` is now an abstract base class, with ``checksum()`` as an abstract method.
184184
This helps ensure that any subclasses implement the ``checksum()`` method.
185185
:issue:`711`
186186

@@ -198,7 +198,7 @@ This is because they were not intended to be public API.
198198

199199
In addition, ``numcodecs.blosc.decompress_partial`` is removed as
200200
has always been experimental and there is no equivalent in the official
201-
blsoc Python package.
201+
blosc Python package.
202202
By :user:`David Stansby <dstansby>`, :issue:`712`
203203

204204
Maintenance
@@ -248,7 +248,7 @@ This is because they are not intended to be public API.
248248

249249
In addition, ``numcodecs.blosc.decompress_partial`` is deprecated as
250250
has always been experimental and there is no equivalent in the official
251-
blsoc Python package.
251+
blosc Python package.
252252
By :user:`David Stansby <dstansby>`, :issue:`619`
253253

254254
Fixes
@@ -329,7 +329,7 @@ Maintenance
329329
~~~~~~~~~~~
330330
* The minimum supported Python version is now Python 3.11.
331331
By :user:`David Stansby <dstansby>`, :issue:`622`
332-
* The minimum supported numpy version is now 1.24.
332+
* The minimum supported NumPy version is now 1.24.
333333
By :user:`David Stansby <dstansby>`, :issue:`622`
334334

335335
.. _release_0.13.1:
@@ -387,17 +387,17 @@ Fix
387387
By :user:`Elliott Sales de Andrade <QuLogic>`, :issue:`487`.
388388
* Fix Upgrade to Zstd 1.5.5 due to potential corruption.
389389
By :user:`Mark Kittisopikul <mkitti>`, :issue:`429`
390-
* Add version constraint(<2.0) for numpy in zfpy.
390+
* Add version constraint(<2.0) for NumPy in zfpy.
391391
By :user:`Tom Liang <px39n>`, :issue:`540`.
392392

393393
Maintenance
394394
~~~~~~~~~~~
395395
* The minimum supported Python version is now Python 3.10.
396396
By :user:`David Stansby <dstansby>`, :issue:`531`
397-
* Add numpy 2 compatibility.
397+
* Add NumPy 2 compatibility.
398398
By :user:`David Stansby <dstansby>`, :issue:`535`
399399
* Update c-blosc to 1.21.0 to 1.21.5, zstd from 1.4.8 to 1.5.5,
400-
lz4 from 1.9.3 to 1.9.4, and zlib from 1.2.8 to to 1.2.13
400+
lz4 from 1.9.3 to 1.9.4, and zlib from 1.2.8 to 1.2.13
401401
By :user:`Mark Kittisopikul <mkitti>`, :issue:`500`
402402

403403

@@ -483,7 +483,7 @@ Maintenance
483483
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`369`.
484484

485485
* Drop Python 3.7.
486-
By :user:`John Kirkham <jakirkham>`,, :issue:`405` :issue:`406`.
486+
By :user:`John Kirkham <jakirkham>`, :issue:`405` :issue:`406`.
487487

488488
* Test with zfpy 1.0.0.
489489
By :user:`John Kirkham <jakirkham>`, :issue:`385`.
@@ -715,7 +715,7 @@ Maintenance
715715
* Automatically release to PyPI.
716716
By :user:`Josh Moore <joshmoore>`, :issue:`241`.
717717

718-
* Build wheels on github actions.
718+
* Build wheels on GitHub Actions.
719719
By :user:`Grzegorz Bokota <Czaki>`, :issue:`224`.
720720

721721
* Add Base64 codec.
@@ -872,7 +872,7 @@ Maintenance
872872
code readability and maintainability. By :user:`John Kirkham <jakirkham>` and
873873
:user:`Alistair Miles <alimanfoo>`; :issue:`119`, :issue:`121`, :issue:`128`.
874874

875-
* Return values from encode() and decode() methods are now returned as numpy
875+
* Return values from encode() and decode() methods are now returned as NumPy
876876
arrays for consistency across codecs. By :user:`John Kirkham <jakirkham>`,
877877
:issue:`136`.
878878

0 commit comments

Comments
 (0)