Include the corresponding issue #s in the CHANGELOGmake-a-better-changelog

1 files changed, 43 insertions, 41 deletions

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index fda15cc..1f98935 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -1,15 +1,17 @@
 XX-XX-XXXX v. X.X.X
 +++++++++++++++++++
 
-   - Formally deprecated old or misleading APIs
-   - Documentation, packaging, and CI cleanup (thanks @jdufresne)
-   - Consolidate API documentation into a single page
+   - Formally deprecated old or misleading APIs (issue #83)
+   - Documentation, packaging, and CI cleanup (thanks @jdufresne) (issues #69, #71-#80)
+   - Consolidate API documentation into a single page (issue #82)
+   - Add a CHANGELOG.rst to the top-level of the repository (issue #85)
+   - Add back support for very old versions of setuptools (issue #84)
 
 09-09-2018 v. 5.4.1
 +++++++++++++++++++
 
-   - Fix error in a newly added test
-   - Changed code format and quality checking infrastructure
+   - Fix error in a newly added test (issues #65, #67)
+   - Changed code format and quality checking infrastructure (issue #68)
 
 09-06-2018 v. 5.4.0
 +++++++++++++++++++
@@ -17,22 +19,22 @@ XX-XX-XXXX v. X.X.X
    - Re-expose ``natsort_key`` as "public" and remove the
      associated ``DepricationWarning``
    - Add better developer documentation
-   - Refactor tests
+   - Refactor tests (issue #66)
    - Bump allowed ``fastnumbers`` version
 
 07-07-2018 v. 5.3.3
 +++++++++++++++++++
 
-   - Update docs with a FAQ and quick how-it-works
+   - Update docs with a FAQ and quick how-it-works (issue #60)
    - Fix a StopIteration error in the testing code
-   - Enable Python 3.7 support in Travis-CI
+   - Enable Python 3.7 support in Travis-CI (issue #61)
 
 05-17-2018 v. 5.3.2
 +++++++++++++++++++
 
-    - Fix bug that prevented install on old versions of setuptools
+    - Fix bug that prevented install on old versions of setuptools (issues #55, #56)
     - Revert layout from src/natsort/ back to natsort/ to make user
-      testing simpler
+      testing simpler (issues #57, #58)
 
 05-14-2018 v. 5.3.1
 +++++++++++++++++++
@@ -46,26 +48,26 @@ XX-XX-XXXX v. X.X.X
 04-20-2018 v. 5.3.0
 +++++++++++++++++++
 
-    - Fix bug in assessing ``fastnumbers`` version at import-time (thanks @hholzgra)
-    - Add ability to consider unicode-decimal numbers as numbers
+    - Fix bug in assessing ``fastnumbers`` version at import-time (thanks @hholzgra) (issues #51, #53)
+    - Add ability to consider unicode-decimal numbers as numbers (issues #52, #54)
 
 02-14-2018 v. 5.2.0
 +++++++++++++++++++
 
-    - Add ``ns.NUMAFTER`` to cause numbers to be placed after non-numbers
-    - Add ``natcmp`` function (Python 2 only) (thanks @rinslow)
+    - Add ``ns.NUMAFTER`` to cause numbers to be placed after non-numbers (issues #48, #49)
+    - Add ``natcmp`` function (Python 2 only) (thanks @rinslow) (issue #47)
 
 11-11-2017 v. 5.1.1
 +++++++++++++++++++
 
     - Added additional unicode number support for Python 3.7
-    - Added information on how to install and test
+    - Added information on how to install and test (issue #46)
 
 08-19-2017 v. 5.1.0
 +++++++++++++++++++
 
-    - Fixed ``StopIteration`` warning on Python 3.6+ (thanks @lykinsbd)
-    - All Unicode input is now normalized
+    - Fixed ``StopIteration`` warning on Python 3.6+ (thanks @lykinsbd) (issues #42, #43)
+    - All Unicode input is now normalized (issue #44, #45)
 
 04-30-2017 v. 5.0.3
 +++++++++++++++++++
@@ -87,16 +89,16 @@ XX-XX-XXXX v. X.X.X
     - The ``ns`` enum attributes can now be imported from the top-level
       namespace
     - Fixed a bug with the ``from natsort import *`` mechanism
-    - Fixed bug with using ``natsort`` with ``python -OO``
+    - Fixed bug with using ``natsort`` with ``python -OO`` (issues #38, #39)
 
 05-08-2016 v. 5.0.0
 +++++++++++++++++++
 
-    - ``ns.LOCALE``/``humansorted`` now accounts for thousands separators.
+    - ``ns.LOCALE``/``humansorted`` now accounts for thousands separators (issue #36)
     - Refactored entire codebase to be more functional (as in use functions as
       units). Previously, the code was rather monolithic and difficult to follow. The
       goal is that with the code existing in smaller units, contributing will
-      be easier
+      be easier (issue #37)
     - Deprecated ``ns.TYPESAFE`` option as it is now always on (due to a new
       iterator-based algorithm, the typesafe function is now cheap)
     - Increased speed of execution (came for free with the new functional approach
@@ -121,20 +123,20 @@ XX-XX-XXXX v. X.X.X
 06-25-2015 v. 4.0.3
 +++++++++++++++++++
 
-    - Fixed bad install on last release (sorry guys!)
+    - Fixed bad install on last release (sorry guys!) (issue #30)
 
 06-24-2015 v. 4.0.2
 +++++++++++++++++++
 
     - Added back Python 2.6 and Python 3.2 compatibility. Unit testing is now
-      performed for these versions (thanks @dpetzold)
+      performed for these versions (thanks @dpetzold) (issue #29)
     - Consolidated under-the-hood compatibility functionality
 
 06-04-2015 v. 4.0.1
 +++++++++++++++++++
 
     - Added support for sorting NaN by internally converting to -Infinity
-      or +Infinity
+      or +Infinity (issue #27)
 
 05-17-2015 v. 4.0.0
 +++++++++++++++++++
@@ -142,16 +144,16 @@ XX-XX-XXXX v. X.X.X
     - Made default behavior of 'natsort' search for unsigned ints,
       rather than signed floats. This is a backwards-incompatible
       change but in 99% of use cases it should not require any
-      end-user changes
+      end-user changes (issue #20)
     - Improved handling of locale-aware sorting on systems where the
-      underlying locale library is broken
+      underlying locale library is broken (issue #34))
     - Greatly improved all unit tests by adding the hypothesis library
 
 04-06-2015 v. 3.5.6
 +++++++++++++++++++
 
     - Added 'UNGROUPLETTERS' algorithm to get the case-grouping behavior of
-      an ordinal sort when using 'LOCALE'
+      an ordinal sort when using 'LOCALE' (issue #23)
     - Added convenience functions 'decoder', 'as_ascii', and 'as_utf8' for
       dealing with bytes types
 
@@ -166,7 +168,7 @@ XX-XX-XXXX v. X.X.X
 +++++++++++++++++++
 
     - Fixed bug where a 'TypeError' was raised if a string containing a leading
-      number was sorted with alpha-only strings when 'LOCALE' is used
+      number was sorted with alpha-only strings when 'LOCALE' is used (issue #22)
 
 03-26-2015 v. 3.5.3
 +++++++++++++++++++
@@ -181,13 +183,13 @@ XX-XX-XXXX v. X.X.X
 +++++++++++++++++++
 
     - Enhancement that will convert a 'pathlib.Path' object to a 'str' if
-      'ns.PATH' is enabled
+      'ns.PATH' is enabled (issue #16)
 
 09-25-2014 v. 3.5.1
 +++++++++++++++++++
 
     - Fixed bug that caused list/tuples to fail when using 'ns.LOWECASEFIRST'
-      or 'ns.IGNORECASE'
+      or 'ns.IGNORECASE' (issue #15)
     - Refactored modules so that only the public API was in natsort.py and
       ns_enum.py
     - Refactored all import statements to be absolute, not relative
@@ -202,9 +204,9 @@ XX-XX-XXXX v. X.X.X
       options are being deprecated and will become (undocumented)
       keyword-only options in natsort version 4.0.0
     - The user can now modify how 'natsort' handles the case of non-numeric
-      characters
+      characters (issue #14)
     - The user can now instruct 'natsort' to use locale-aware sorting, which
-      allows 'natsort' to perform true "human sorting"
+      allows 'natsort' to perform true "human sorting" (issue #14)
 
       - The `humansorted` convenience function has been included to make this
         easier
@@ -224,14 +226,14 @@ XX-XX-XXXX v. X.X.X
 +++++++++++++++++++
 
     - Fixed a bug that caused user's options to the 'natsort_key' to not be
-      passed on to recursive calls of 'natsort_key'
+      passed on to recursive calls of 'natsort_key' (issue #12)
     - Added a 'natsort_keygen' function that will generate a wrapped version
       of 'natsort_key' that is easier to call.  'natsort_key' is now set to
       deprecate at natsort version 4.0.0
     - Added an 'as_path' option to 'natsorted' & co. that will try to treat
       input strings as filepaths. This will help yield correct results for
       OS-generated inputs like
-      ``['/p/q/o.x', '/p/q (1)/o.x', '/p/q (10)/o.x', '/p/q/o (1).x']``
+      ``['/p/q/o.x', '/p/q (1)/o.x', '/p/q (10)/o.x', '/p/q/o (1).x']`` (issue #3)
     - Massive performance enhancements for string input (1.8x-2.0x), at the expense
       of reduction in speed for numeric input (~2.0x)
 
@@ -252,11 +254,11 @@ XX-XX-XXXX v. X.X.X
 06-28-2014 v. 3.3.0
 +++++++++++++++++++
 
-    - Added a 'versorted' method for more convenient sorting of versions
+    - Added a 'versorted' method for more convenient sorting of versions (issue #11)
     - Updated command-line tool --number_type option with 'version' and 'ver'
       to make it more clear how to sort version numbers
     - Moved unit-testing mechanism from being docstring-based to actual unit tests
-      in actual functions
+      in actual functions (issue #10)
 
       - This has provided the ability determine the coverage of the unit tests (99%)
       - This also makes the pydoc documentation a bit more clear
@@ -268,27 +270,27 @@ XX-XX-XXXX v. X.X.X
 +++++++++++++++++++
 
     - Re-"Fixed" unorderable types issue on Python 3.x - this workaround
-      is for when the problem occurs in the middle of the string
+      is for when the problem occurs in the middle of the string (issue #7 again)
 
 05-07-2014 v. 3.2.0
 +++++++++++++++++++
 
     - "Fixed" unorderable types issue on Python 3.x with a workaround that
       attempts to replicate the Python 2.x behavior by putting all the numbers
-      (or strings that begin with numbers) first
+      (or strings that begin with numbers) first (issue #7)
     - Now explicitly excluding __pycache__ from releases by adding a prune statement
       to MANIFEST.in
 
 05-05-2014 v. 3.1.2
 +++++++++++++++++++
 
-    - Added setup.cfg to support universal wheels
+    - Added setup.cfg to support universal wheels (issue #6)
     - Added Python 3.0 and Python 3.1 as requiring the argparse module
 
 03-01-2014 v. 3.1.1
 +++++++++++++++++++
 
-    - Added ability to sort lists of lists
+    - Added ability to sort lists of lists (issue #5)
     - Cleaned up import statements
 
 01-20-2014 v. 3.1.0
@@ -321,7 +323,7 @@ XX-XX-XXXX v. X.X.X
 8-15-2013 v. 3.0.1
 ++++++++++++++++++
 
-    - Added support for unicode strings
+    - Added support for unicode strings (issue #2)
     - Removed extraneous ``string2int`` function
     - Fixed empty string removal function
 
@@ -336,7 +338,7 @@ XX-XX-XXXX v. X.X.X
 ++++++++++++++++++
 
     - Added ``key`` attribute to ``natsorted`` and ``index_natsorted`` so that
-      it mimics the functionality of the built-in ``sorted``
+      it mimics the functionality of the built-in ``sorted`` (issue #1)
     - Added tests to reflect the new functionality, as well as tests demonstrating
       how to get similar functionality using ``natsort_key``