Skip to content

Commit 3bbd4b0

Browse files
pluchtsebastianbergmann
authored andcommitted
add a note about @testdox to Data Provider section
resolves sebastianbergmann#218
1 parent 6987110 commit 3bbd4b0

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/writing-tests-for-phpunit.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,12 @@ Output will be more verbose as it'll contain that name of a dataset that breaks
368368
FAILURES!
369369
Tests: 4, Assertions: 4, Failures: 1.
370370
371+
.. admonition:: Note
372+
373+
You can make the test output more verbose by defining a sentence and using the test's parameter names as placeholders
374+
(``$a``, ``$b`` and ``$expected`` in the example above) with the :ref:`appendixes.annotations.testdox` annotation.
375+
You can also refer to the name of a named data set with ``$_dataName``.
376+
371377
.. code-block:: php
372378
:caption: Using a data provider that returns an Iterator object
373379
:name: writing-tests-for-phpunit.data-providers.examples.DataTest2.php
@@ -442,7 +448,7 @@ Output will be more verbose as it'll contain that name of a dataset that breaks
442448
if (is_array($row)) {
443449
$row = array_map('intval', $row);
444450
}
445-
451+
446452
$this->key = 0;
447453
}
448454

0 commit comments

Comments
 (0)