Skip to content

Commit

Permalink
updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
gwthm-in committed Jan 21, 2018
1 parent d0f6b1a commit b30637b
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A `pspec format`_ reporter for pytest

.. _pspec format: https://en.wikipedia.org/wiki/RSpec

.. image:: http://i.imgur.com/rJRL4x9.png
.. image:: https://i.imgur.com/mwA9SRN.png

Install
-------
Expand Down Expand Up @@ -42,6 +42,35 @@ in your `ini file <https://docs.pytest.org/en/latest/customize.html#initializati
addopts = --pspec
Demo Code
---------

Add the doc strings Ex:

.. code-block:: python
import unittest
class TestWayTwo(unittest.TestCase):
"Pspec Python TDD"
def test_should_add(self):
"it adds two integers and returns integer"
self.assertEqual(2+2, 4)
def test_should_find_difference_between_integers(self):
self.assertEqual(4-2, 2)
running ``pytest --pspec`` outputs

.. code-block::
demo
✓ it adds two integers and returns integer
✓ should find difference between integers
Configuration file options
--------------------------

Expand Down

0 comments on commit b30637b

Please sign in to comment.