Version 1.24 changes

BYU-Hydroinformatics · Apr 23, 2019 · 42a84f3 · 42a84f3
1 parent e2689df
commit 42a84f3
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/docs/change_log.rst b/docs/change_log.rst
@@ -0,0 +1,12 @@
+Release Notes
+=============
+
+This is the list of changes to HydroErr between each release. For full details, see the commit logs at
+https://github.com/BYU-Hydroinformatics/HydroErr.
+
+Version 1.24
+^^^^^^^^^^^^
+- Added .name and .abbr properties to each metric to give a little bit more info to the users, and also for ease of use
+  in the Hydrostats package.
+- Allowed users to import all metrics by simply using :code:`import HydroErr` instead of
+  :code:`import HydroErr.HydroErr`.
diff --git a/docs/conf.py b/docs/conf.py
@@ -26,7 +26,7 @@
 author = 'Wade Roberts, Gustavious Williams'
 
 # The short X.Y version
-version = '1.23'
+version = '1.24'
 # The full version, including alpha/beta/rc tags
 release = ''
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -11,6 +11,7 @@ Welcome to HydroErr's documentation!
    installation
    list_of_metrics
    contribute
+   change_log
 
 Indices and tables
 ==================

diff --git a/setup.py b/setup.py
@@ -8,7 +8,7 @@
 setup(
     name='HydroErr',
     packages=['HydroErr'],
-    version='1.23',
+    version='1.24',
     description='Goodness of fit metrics for use in comparison studies, specifically for use in the field '
                 'of hydrology',
     long_description=long_description,