update docs and release log

Author: derek73

CONTRIBUTING.md

@@ -4,25 +4,34 @@ Contributing
 Development Environment Setup
 --------------------------------
 
-The project has no external dependencies so your environment setup is pretty much up to you. If you are running Python 2.6 you will need to `pip install unitest2` in order to run the tests.
+There are some exernal dependencies required in order to run the
+tests, located in the dev-requirements.txt file.
+
+    pip install -r dev-requirements.txt
+
+If you are running Python 2.6 you will also need to `pip install unitest2`
+in order to run the tests.
 
 Travis CI
 ---------
 
 [![Build Status](https://travis-ci.org/derek73/python-nameparser.svg?branch=master)](https://travis-ci.org/derek73/python-nameparser)
 
-The GitHub project is set up with Travis CI. Tests are run automatically against new code pushes to any branch in the main repository. Test results may be viewed here:
+The GitHub project is set up with Travis CI. Tests are run
+automatically against new code pushes to any branch in the main
+repository. Test results may be viewed here:
 
 https://travis-ci.org/derek73/python-nameparser
 
 Running Tests
 ---------------
 
-To run the tests locally, just run `python tests.py`.
+To run the tests locally, run `python tests.py`.
 
 
     python tests.py
 
+
 You can also pass a name string to `tests.py` to see how it will be parsed.
 
     $ python tests.py "Secretary of State Hillary Rodham-Clinton"
@@ -38,20 +47,36 @@ You can also pass a name string to `tests.py` to see how it will be parsed.
 Writing Tests
 ----------------
 
-If you make changes, please make sure you include tests with example names that you want to be parsed correctly. 
+If you make changes, please make sure you include tests with example
+names that you want to be parsed correctly.
+
+It's a good idea to include tests of alternate comma placement formats
+of the name to ensure that the 3 code paths for the 3 formats work in
+the same way.
 
-It's a good idea to include tests of alternate comma placement formats of the name to ensure that the 3 code paths for the 3 formats work in the same way.
+The tests could be MUCH better. If the spirit moves you to design or
+implement a much more intelligent test strategy, please know that your
+efforts will be welcome and appreciated.
 
-The tests could be MUCH better. If the spirit moves you to design or implement a much more intelligent test strategy, please know that your efforts will be welcome and appreciated.
+Unless you add better coverage someplace else, add a few examples of
+your names to `TEST_NAMES`. A test attempts to try the 3 different
+comma variations of these names automatically and make sure things
+don't blow up, so it can be a helpful regression indicator.
 
-Unless you add better coverage someplace else, add a few examples of your names to `TEST_NAMES`. A test attempts to try the 3 different comma variations of these names automatically and make sure things don't blow up, so it can be a helpful regression indicator.
 
 Provide Example Data
 ----------------------
 
-We humans are the learning machine behind this code, and we can't do it without real world data. If it doesn't work, start a new issue because we probably don't know. 
+We humans are the learning machine behind this code, and we can't do
+it without real world data. If it doesn't work, start a new issue
+because we probably don't know.
 
-If you have a dataset that has lots of issues, add the data to a [gist](https://gist.github.com) and [create a new issue](https://github.com/derek73/python-nameparser/issues) so we can try to get it working as expected.
+If you have a dataset that has lots of issues, add the data to a
+[gist](https://gist.github.com) and [create a new
+issue](https://github.com/derek73/python-nameparser/issues) so we can
+try to get it working as expected.
 
-Feel free to update this documentation to address any questions that I missed. GitHub makes it pretty easy to edit it right on the web site now. 
+Feel free to update this documentation to address any questions that I
+missed. GitHub makes it pretty easy to edit it right on the web site
+now.
 

docs/customize.rst

@@ -35,6 +35,7 @@ directly to the attribute.
   >>> hn = HumanName("Dr. John A. Kenneth Doe")
   >>> hn.title = ["Associate","Professor"]
   >>> hn.suffix = "Md."
+  >>> hn.suffix
   <HumanName : [
   	title: 'Associate Processor' 
   	first: 'John' 

docs/release_log.rst

@@ -2,6 +2,7 @@ Release Log
 ===========
 * 0.3.7 - August 30, 2015
     - Make HumanName instances pickleable
+    - Speed improvement, 3x faster
 * 0.3.6 - August 6, 2015
     - Fix strings that start with conjunctions (#20)
     - handle assigning lists of names to a name attribute