DOC: added "what's new" page

tritemio · Aug 25, 2016 · cc40def · cc40def
1 parent bba72ad
commit cc40def
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -80,6 +80,7 @@ to run the example notebooks).
     :maxdepth: 1
     :caption: Reference
 
+    whatsnew
     api
 
 

diff --git a/docs/whatsnew.rst b/docs/whatsnew.rst
@@ -0,0 +1,24 @@
+Pybroom's Release Notes
+=======================
+
+Version 0.2
+-----------
+
+- Improved support for `scipy.optimize` fit result.
+- In addition to list of fit results, `pybroom` now supports:
+
+    - dict of fit results,
+    - dict of lists of fit results
+    - any other nested combination.
+
+- When input contains a dict, pybroom adds "key" column of type
+  `pandas.Categorical`.
+  When input contains a list, pybroom adds a "key" column (i.e. list index)
+  of type `int64`.
+- Updated and expanded documentation and notebooks.
+
+Version 0.1
+-----------
+
+- Support `lmfit` and `scipy.optimize` fit results.
+- Support lists of fit results.