Merge pull request #8 from jmenglund/develop

Fixed docs

README.rst

@@ -38,7 +38,7 @@ Testing is carried out with `pytest <http://pytest.org>`_. The following
 example shows how you can run the test suite and generate a coverage report
 with `coverage <https://coverage.readthedocs.io/>`_:
 
-.. code-block:: bash
+.. code-block::
 
     $ py.test -v --pep8 pandasvalidation.py
     $ coverage run -m py.test

docs/source/pandas-validation/installation.rst

@@ -8,21 +8,22 @@ Installing pandas-validation
 For most users, the easiest way is probably to install the latest version
 hosted on `PyPI <https://pypi.python.org/>`_:
 
-.. code-block::
+.. code-block:: none
 
     $ pip install pandas-validation
 
 The project is hosted at https://github.com/jmenglund/pandas-validation and
 can also be installed using git:
 
-.. code-block::
+.. code-block:: none
 
     $ git clone https://github.com/jmenglund/pandas-validation.git
     $ cd pandas-validation
     $ python setup.py install
 
 .. tip::
-   You may consider installing pandas-validation (and its required packages)
-   within a virtual environment in order to avoid cluttering your system's
-   Python path. See for example the package
-   `virtualenv <https://virtualenv.pypa.io/en/latest/>`_.
+    You may consider installing pandas-validation and its required Python
+    packages within a virtual environment in order to avoid cluttering your
+    system's Python path. See for example the environment management system
+    `conda <http://conda.pydata.org>`_ or the package
+    `virtualenv <https://virtualenv.pypa.io/en/latest/>`_.

docs/source/pandas-validation/quickstart.rst

@@ -7,16 +7,15 @@ Quickstart
 
 This guide gives you a brief introduction on how to use pandas-validation.
 The library contains three core functions that let you validate values in a
-pandas Series. The examples shown below will help you get started. If you
-want to know more, I suggest that you have a look at the
-:ref:`API reference<api>`.
+pandas Series. The examples below will help you get started. If you want to
+know more, I suggest that you have a look at the :ref:`API reference<api>`.
 
 * :ref:`validate-dates`
 * :ref:`validate-numbers`
 * :ref:`validate-strings`
 
 
-The code examples below assumes that you first do the following imports:
+The code examples below assume that you first do the following imports:
 
 .. code-block:: pycon
 
@@ -32,8 +31,8 @@ Validate datetimes
 
 Our first example shows how to validate a pandas Series with a few dates
 entered as strings. The strings will be automatically converted to datetimes
-before the validation is done. Warnings will then be issued and inform the
-user that values are invalid. If `return_values` is set to ``True``, a
+before they are validated. Warnings will then be issued and inform the
+user that some values are invalid. If `return_values` is set to ``True``, a
 pandas Series will be returned with the values converted to the datetime
 data type.
 

release-checklist.rst

@@ -3,35 +3,39 @@ Release checklist
 
 Things to remember when making a new release of pandas-validation.
 
-#.  Changes should be made to some branch other than master (a pull request should then be created before making the release).
-
-#.  Update the release (version) numbers in *setup.py* and *pandasvalidation.py*.
+#.  Changes should be made to some branch other than master (a pull request
+    should then be created before making the release).
 
 #.  Make desirable changes to the code.
 
 #.  Run tests with PEP8 check and report coverage:
 
-    .. code-block:: bash
+    .. code-block:: none
 
         $ py.test -v --pep8 pandasvalidation.py
         $ coverage run -m py.test
         $ coverage report --include pandasvalidation.py -m
 
-#.  Update *README.rst* and the documentation (in `docs/`).
+#.  Update ``README.rst`` and the documentation (in ``docs/``).
 
-    .. code-block:: bash
+    .. code-block:: none
 
         $ sphinx-build -b html ./docs/source ./docs/_build/html
 
-#.  Update *CHANGELOG.rst*.
+#.  Update ``CHANGELOG.rst``.
+
+#.  Update the release (version) number in `setup.py` and
+    ``pandasvalidation.py``. Use `Semantic Versioning <http://semver.org>`_.
 
 #.  Create pull request(s) with changes for the new release.
 
-#.  Create the new release in GitHub.
+#.  Create distributions and upload the files to
+    `PyPI <https://pypi.python.org/pypi>`_ with
+    `twine <https://github.com/pypa/twine>`_.
 
-#.  Create distributions and upload the files to `PyPI <https://pypi.python.org/pypi>`_.
+    .. code-block:: none
 
-    .. code-block:: bash
+        $ python setup.py sdist bdist_wheel
+        $ twine upload dist/*
 
-        $ python setup.py bdist_wheel --universal
-        $ python setup.py sdist
+#.  Create the new release in GitHub.