Add release notes for v0.3.1

mhostetter · Dec 12, 2022 · 638f0aa · 638f0aa
1 parent deb4c1e
commit 638f0aa
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -78,7 +78,7 @@ Import the `galois` package in Python.
 In [1]: import galois
 
 In [2]: galois.__version__
-Out[2]: '0.3.0'
+Out[2]: '0.3.1'
 ```
 
 ### Create a [`FieldArray`](https://mhostetter.github.io/galois/latest/api/galois.FieldArray/) subclass

diff --git a/docs/index.rst b/docs/index.rst
@@ -145,6 +145,7 @@ If this library was useful to you in your research, please cite us. Following th
  :hidden:
 
  release-notes/versioning.rst
+ release-notes/v0.3.1.md
  release-notes/v0.3.0.md
  release-notes/v0.2.0.md
  release-notes/v0.1.2.md

diff --git a/docs/release-notes/v0.3.1.md b/docs/release-notes/v0.3.1.md
@@ -0,0 +1,25 @@
+# v0.3.1
+
+*Released December 12, 2022*
+
+## Changes
+
+- Fixed a bug in the Pollard $\rho$ factorization algorithm that caused an occasional infinite loop. ([#450](https://github.com/mhostetter/galois/pull/450))
+ ```ipython
+ In [1]: import galois
+
+ # v0.3.0
+ In [2]: %time galois.GF(2400610585866217)
+ # Never returns...
+
+ # v0.3.1
+ In [2]: %time galois.GF(2400610585866217)
+ Wall time: 96 ms
+ Out[2]: <class 'galois.GF(2400610585866217)'>
+ ```
+- Formatted the code and unit tests with `black` and `isort`. ([#446](https://github.com/mhostetter/galois/pull/446), [#449](https://github.com/mhostetter/galois/pull/449))
+
+## Contributors
+
+- Matt Hostetter ([@mhostetter](https://github.com/mhostetter))
+- [@pivis](https://github.com/pivis)