diff --git a/README.md b/README.md index 97e68e313..1f9ed757b 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ Import the `galois` package in Python. In [1]: import galois In [2]: galois.__version__ -Out[2]: '0.0.32' +Out[2]: '0.0.33' ``` ### Create a [`FieldArray`](https://galois.readthedocs.io/en/latest/api/galois.FieldArray/) subclass diff --git a/docs/index.rst b/docs/index.rst index 6ad05faf2..3d334ee8a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -140,6 +140,7 @@ If this library was useful to you in your research, please cite us. Following th :hidden: release-notes/versioning.rst + release-notes/v0.0.33.md release-notes/v0.0.32.md release-notes/v0.0.31.md release-notes/v0.0.30.md diff --git a/docs/release-notes/v0.0.33.md b/docs/release-notes/v0.0.33.md new file mode 100644 index 000000000..b7ca49274 --- /dev/null +++ b/docs/release-notes/v0.0.33.md @@ -0,0 +1,17 @@ +# v0.0.33 + +*Released August 26, 2022* + +## Breaking changes + +- Modified FEC `encode()`, `detect()`, and `decode()` methods to always return `FieldArray` instances, not `np.ndarray`. ([#397](https://github.com/mhostetter/galois/pull/397)) + - Invoke `.view(np.ndarray)` on the output to convert it back to a NumPy array, if needed. + +## Changes + +- Added support for `ArrayLike` inputs to FEC `encode()`, `detect()`, and `decode()` methods. ([#397](https://github.com/mhostetter/galois/pull/397)) +- Modified library packaging to use `pyproject.toml` and a `src/` source code folder. ([#404](https://github.com/mhostetter/galois/pull/404)) + +## Contributors + +- Matt Hostetter ([@mhostetter](https://github.com/mhostetter))