Skip to content

Commit

Permalink
Minor documentation changes on how to run tests
Browse files Browse the repository at this point in the history
Adds ArtOfCode to AUTHORS.rst
  • Loading branch information
AWegnerGitHub committed Mar 11, 2016
1 parent c1c6ee7 commit afd8d66
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
5 changes: 4 additions & 1 deletion AUTHORS.rst
Expand Up @@ -9,4 +9,7 @@ Andrew Wegner `@AWegnerGitHub <https://github.com/AWegnerGitHub/stackapi>`_
Patches and Suggestions
```````````````````````

No one else, yet. :ref:`Contribute <contributing>` a feature and get your name here!
`@ArtOfCode- <https://github.com/ArtOfCode->`_


:ref:`Contribute <contributing>` a feature and get your name here!
10 changes: 7 additions & 3 deletions docs/dev/contributing.rst
Expand Up @@ -75,19 +75,23 @@ Running Tests
~~~~~~~~~~~~~

To be able to run the test suite, you'll need to have `mock`_ installed. Mock is
on the Python Package Index, so you can install it simply with one command:
on the Python Package Index, so you can install it simply with one command::

$ pip install mock

Tests are built and run using `unittest`_, which comes as a standard package with
every Python installation. You can run the tests using the following command
(from the root directory of your clone):
(from the root directory of your clone)::

$ python -m unittest discover tests/
$ python -m unittest discover

.. _mock: https://pypi.python.org/pypi/mock
.. _unittest: https://docs.python.org/2/library/unittest.html

The ``mock`` installation step can be handled automatically, if you run tests via::

$ python setup.py test

Code Review
~~~~~~~~~~~

Expand Down

0 comments on commit afd8d66

Please sign in to comment.