Updated documentation

serenpa · Dec 21, 2018 · 4e6e7cb · 4e6e7cb
1 parent f06fca0
commit 4e6e7cb
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -11,6 +11,7 @@ Contributors
 ------------
 
 * Liz Richardson
+* Stefan Hall
 * Adrien Aucher
 
 Want to contribute? See: CONTRIBUTING.rst

diff --git a/HISTORY.rst b/HISTORY.rst
@@ -10,5 +10,7 @@ History
 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
 | First half of 2017 | Adrien Aucher joins UC as an intern and works with Ashley Williams on the first version of this tool. It is only used internally at this point. |
 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
-| November 2018      | Liz Richardson joins the project to work on the first release. Version 1.0.0 released.                                                          |
+| November 2018      | Liz Richardson and Stefan Hall join the project to work on the first release.                                                                   |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| December 2018      | Version 1.0.0 released.                                                                                                                         |
 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/coast_search/utils.py b/coast_search/utils.py
@@ -1,8 +1,6 @@
 """
-    Title: file_utils.py
-
+    Title: utils.py
     Author: Ashley Williams
-
     Description: A collection of generic utility functions that are used
     throughout coast by various modules relating to reading and writing to
     files.

diff --git a/docs/source/modules/query_generator.rst b/docs/source/modules/query_generator.rst
@@ -5,7 +5,7 @@ Query Generator
 
 Introduction
 ------------
-The query generator module contains functions that can be used to generate a set of queries that follow the heuristics proposed by Rainer and Williams in IST'18_
+The query generator module contains functions that can be used to generate a set of queries that follow the heuristics proposed by Rainer and Williams in `IST'18`_
 
 .. _IST'18: https://www.sciencedirect.com/science/article/abs/pii/S0950584918302192
 

diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.1
+current_version = 1.0.0
 commit = True
 tag = True
 
@@ -13,4 +13,3 @@ replace = __version__ = '{new_version}'
 
 [wheel]
 universal = 1
-
diff --git a/setup.py b/setup.py
@@ -29,7 +29,7 @@
     author="Ashley Williams",
     author_email='[email protected]',
     classifiers=[
-        'Development Status :: 3 - Alpha',
+        'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
         'Intended Audience :: Education',
         'Intended Audience :: Science/Research',
@@ -50,7 +50,7 @@
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/zedrem/coast_search',
-    version='0.0.1',
+    version='1.0.0',
     zip_safe=False,
     dependency_links=dependency_links
 )