Skip to content

Commit 596f73a

Browse files
committed
Proper capitalization
1 parent 7a5d3f3 commit 596f73a

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

CHANGELOG.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Changelog
1010
version 0.3.0-dev
1111
-----------------
1212
+ Added a source tarball for isa-l in the package, so it can be compiled and
13-
statically linked on (unix) systems that do not have isa-l available in the
14-
repos. Linux wheels can be provided on PYPI as well because of this change.
13+
statically linked on (Unix) systems that do not have ISA-L available in the
14+
repos. Linux wheels can be provided on PyPI as well because of this change.
1515

1616
version 0.2.0
1717
-----------------

README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ python-isal
3131
===========
3232

3333
Faster zlib and gzip compatible compression and decompression
34-
by providing python bindings for the isa-l library.
34+
by providing Python bindings for the ISA-L library.
3535

36-
This package provides Python bindings for the `isa-l
36+
This package provides Python bindings for the `ISA-L
3737
<https://github.com/intel/isa-l>`_ library. The Intel Infrastructure Storage
38-
Acceleration Library (isa-l) implements several key algorithms in `assembly
38+
Acceleration Library (ISA-L) implements several key algorithms in `assembly
3939
language <https://en.wikipedia.org/wiki/Assembly_language>`_. This includes
4040
a variety of functions to provide zlib/gzip-compatible compression.
4141

@@ -60,13 +60,13 @@ The latest development version of python-isal can be installed with::
6060

6161
pip install git+https://github.com/rhpvorderman/python-isal.git
6262

63-
isa-l is available in numerous Linux distro's as well as on conda via the
63+
ISA-L is available in numerous Linux distro's as well as on conda via the
6464
conda-forge channel. Checkout the `ports documentation
65-
<https://github.com/intel/isa-l/wiki/Ports--Repos>`_ on the isa-l project wiki
65+
<https://github.com/intel/isa-l/wiki/Ports--Repos>`_ on the ISA-L project wiki
6666
to find out how to install it. It is important that the development headers
6767
are also installed.
6868

69-
On debian and ubuntu the isa-l libraries (including the development headers)
69+
On Debian and Ubuntu the ISA-L libraries (including the development headers)
7070
can be installed with:
7171

7272
.. code-block::
@@ -121,7 +121,7 @@ Differences with zlib and gzip modules
121121

122122
+ Compression level 0 in ``zlib`` and ``gzip`` means **no compression**, while
123123
in ``isal_zlib`` and ``igzip`` this is the **lowest compression level**.
124-
This is a design choice that was inherited from the isa-l library.
124+
This is a design choice that was inherited from the ISA-L library.
125125
+ Compression levels range from 0 to 3, not 1 to 9.
126126
+ ``isal_zlib.crc32`` and ``isal_zlib.adler32`` do not support negative
127127
numbers for the value parameter.

0 commit comments

Comments
 (0)