From 1db3bacaab1f68344806ad91ebb6ab62c06a6788 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 8 Oct 2018 02:21:20 -0700 Subject: Replace [test] with [testing], and quote as needed --- docs/quick_tutorial/unit_testing.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/quick_tutorial/unit_testing.rst') diff --git a/docs/quick_tutorial/unit_testing.rst b/docs/quick_tutorial/unit_testing.rst index 2e58ee8d9..283730f0f 100644 --- a/docs/quick_tutorial/unit_testing.rst +++ b/docs/quick_tutorial/unit_testing.rst @@ -54,14 +54,14 @@ Steps .. literalinclude:: unit_testing/setup.py :language: python :linenos: - :emphasize-lines: 11-15 + :emphasize-lines: 11-16, 21-23 #. Install our project and its newly added dependency. - Note that we use the extra specifier ``[test]`` to install testing requirements. + Note that we use the extra specifier ``[testing]`` to install testing requirements and surround it with double quote marks. .. code-block:: bash - $VENV/bin/pip install -e .[test] + $VENV/bin/pip install -e ".[testing]" #. Now we write a simple unit test in ``unit_testing/tutorial/tests.py``: -- cgit v1.2.3 From 23fbcac9c35c5f74a1258a72100518fcff3b03e3 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 8 Oct 2018 23:57:55 -0700 Subject: Use correct invocation of `pip install - e ".[dev]"` instead of [testing] --- docs/quick_tutorial/unit_testing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/quick_tutorial/unit_testing.rst') diff --git a/docs/quick_tutorial/unit_testing.rst b/docs/quick_tutorial/unit_testing.rst index 283730f0f..4170e9e06 100644 --- a/docs/quick_tutorial/unit_testing.rst +++ b/docs/quick_tutorial/unit_testing.rst @@ -57,11 +57,11 @@ Steps :emphasize-lines: 11-16, 21-23 #. Install our project and its newly added dependency. - Note that we use the extra specifier ``[testing]`` to install testing requirements and surround it with double quote marks. + Note that we use the extra specifier ``[dev]`` to install testing requirements and surround it with double quote marks. .. code-block:: bash - $VENV/bin/pip install -e ".[testing]" + $VENV/bin/pip install -e ".[dev]" #. Now we write a simple unit test in ``unit_testing/tutorial/tests.py``: -- cgit v1.2.3 From beeb8ee80c1d0823f965e5826ce3633972904dab Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 9 Oct 2018 00:11:51 -0700 Subject: Align emphasize-lines with setup.py code --- docs/quick_tutorial/unit_testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/quick_tutorial/unit_testing.rst') diff --git a/docs/quick_tutorial/unit_testing.rst b/docs/quick_tutorial/unit_testing.rst index 4170e9e06..dc14a19d0 100644 --- a/docs/quick_tutorial/unit_testing.rst +++ b/docs/quick_tutorial/unit_testing.rst @@ -54,7 +54,7 @@ Steps .. literalinclude:: unit_testing/setup.py :language: python :linenos: - :emphasize-lines: 11-16, 21-23 + :emphasize-lines: 15 #. Install our project and its newly added dependency. Note that we use the extra specifier ``[dev]`` to install testing requirements and surround it with double quote marks. -- cgit v1.2.3 From b15a06346148f6095adf17893490175abc95a494 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 9 Oct 2018 00:14:00 -0700 Subject: Rearrange introduction of Setuptools and move to debugtoolbar. Replace [testing] with [dev]. Make narrative text more descriptive of what is going on with `extras_require` --- docs/quick_tutorial/unit_testing.rst | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) (limited to 'docs/quick_tutorial/unit_testing.rst') diff --git a/docs/quick_tutorial/unit_testing.rst b/docs/quick_tutorial/unit_testing.rst index dc14a19d0..654925347 100644 --- a/docs/quick_tutorial/unit_testing.rst +++ b/docs/quick_tutorial/unit_testing.rst @@ -57,7 +57,7 @@ Steps :emphasize-lines: 15 #. Install our project and its newly added dependency. - Note that we use the extra specifier ``[dev]`` to install testing requirements and surround it with double quote marks. + Note that we use the extra specifier ``[dev]`` to install testing requirements for development and surround it and the period with double quote marks. .. code-block:: bash @@ -102,11 +102,6 @@ Note that our use of ``pyramid.testing.setUp()`` and necessary when your test needs to make use of the ``config`` object (it's a Configurator) to add stuff to the configuration state before calling the view. -Finally we've introduced the concept of :term:`Setuptools` extras. -These are optional or recommended features that may be installed with an "extras" specifier. -The specifier is the name of a key in a Python dictionary, and is surrounded by square brackets when invoked on the command line. -The value for the key is a Python list of dependencies. - Extra credit ============ -- cgit v1.2.3