Skip to content

Commit

Permalink
Minor test format doc improvements
Browse files Browse the repository at this point in the history
Turn a paragraph identified as a note into an rst-styled note.

Clarify how the 'url' key is required.
  • Loading branch information
cdent committed Dec 30, 2016
1 parent 970fb65 commit efbaf13
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/source/format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit efbaf13

Please sign in to comment.