openstack
/
deb-python-gabbi
Code Issues Proposed changes

Minor test format doc improvements 

Turn a paragraph identified as a note into an rst-styled note.

Clarify how the 'url' key is required.
This commit is contained in:
Chris Dent 2016-12-30 15:14:27 +00:00
parent 970fb6572b
commit efbaf13629
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/source/format.rst
View File

@ -57,10 +57,10 @@ Metadata
Note that the test will be run anyway.
=========== ================================================= ============
Note: When tests are generated dynamically, the ``TestCase`` name will include
the respective test's ``name``, lowercased with spaces transformed to ``_``. In
at least some test runners this will allow you to select and filter on test
name.
.. note:: When tests are generated dynamically, the ``TestCase`` name will
include the respective test's ``name``, lowercased with spaces
transformed to ``_``. In at least some test runners this will allow
you to select and filter on test name.
.. _request-parameters:
@ -89,11 +89,11 @@ Request Parameters
``method`` The HTTP request method. defaults to
``GET``
``url`` The URL to request. This can either be a **required**
full path (e.g. "/index") or a fully
qualified URL (i.e. including host and
scheme, e.g.
"http://example.org/index") — see
``url`` The URL to request. This can either be a Either this
full path (e.g. "/index") or a fully or the
qualified URL (i.e. including host and shortcut
scheme, e.g. above is
"http://example.org/index") — see **required**
:doc:`host` for details.
``request_headers`` A dictionary of key-value pairs