From b15a06346148f6095adf17893490175abc95a494 Mon Sep 17 00:00:00 2001
From: Steve Piercy <web@stevepiercy.com>
Date: Tue, 09 Oct 2018 09:14:00 +0200
Subject: [PATCH] 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/debugtoolbar.rst | 10 ++++++++--
docs/quick_tutorial/functional_testing.rst | 2 +-
docs/quick_tutorial/unit_testing.rst | 7 +------
3 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/docs/quick_tutorial/debugtoolbar.rst b/docs/quick_tutorial/debugtoolbar.rst
index 907f3e0..2607c83 100644
--- a/docs/quick_tutorial/debugtoolbar.rst
+++ b/docs/quick_tutorial/debugtoolbar.rst
@@ -38,7 +38,7 @@
cd ..; cp -r ini debugtoolbar; cd debugtoolbar
-#. Add ``pyramid_debugtoolbar`` to our project's dependencies in ``setup.py``:
+#. Add ``pyramid_debugtoolbar`` to our project's dependencies in ``setup.py`` as a :term:`Setuptools` "extra" for development:
.. literalinclude:: debugtoolbar/setup.py
:language: python
@@ -46,10 +46,11 @@
:emphasize-lines: 10-16, 20-22
#. Install our project and its newly added dependency.
+ Note that we use the extra specifier ``[dev]`` to install development requirements and surround it and the period with double quote marks.
.. code-block:: bash
- $VENV/bin/pip install -e .
+ $VENV/bin/pip install -e ".[dev]"
#. Our ``debugtoolbar/development.ini`` gets a configuration entry for ``pyramid.includes``:
@@ -96,6 +97,11 @@
by commenting out the ``pyramid_debugtoolbar`` line in ``pyramid.includes``
temporarily.
+Finally we've introduced the concept of :term:`Setuptools` extras.
+These are optional or recommended features that may be installed with an "extras" specifier, in this case, ``dev``.
+The specifier is the name of a key in a Python dictionary, and is surrounded by square brackets when invoked on the command line, for example, .
+The value for the key is a Python list of dependencies.
+
.. seealso:: See also :ref:`pyramid_debugtoolbar <toolbar:overview>`.
diff --git a/docs/quick_tutorial/functional_testing.rst b/docs/quick_tutorial/functional_testing.rst
index a4676d7..054d037 100644
--- a/docs/quick_tutorial/functional_testing.rst
+++ b/docs/quick_tutorial/functional_testing.rst
@@ -45,7 +45,7 @@
:emphasize-lines: 16
#. 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
diff --git a/docs/quick_tutorial/unit_testing.rst b/docs/quick_tutorial/unit_testing.rst
index dc14a19..6549253 100644
--- a/docs/quick_tutorial/unit_testing.rst
+++ b/docs/quick_tutorial/unit_testing.rst
@@ -57,7 +57,7 @@
: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
@@ -101,11 +101,6 @@
``pyramid.testing.tearDown()`` aren't actually necessary here; they are only
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
--
Gitblit v1.9.3