From af6952d334a054e05f0ae1cb91401e3ba7d9481d Mon Sep 17 00:00:00 2001 From: Mathias Brodala Date: Tue, 26 Mar 2024 08:49:10 +0100 Subject: [PATCH] [TASK] Clarify trait usage Properly state that this is a trait, the class name does not suggest so ATM. Also suggest renaming it on import to avoid confusion. --- README.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 56d1569..7f145f4 100644 --- a/README.rst +++ b/README.rst @@ -51,11 +51,18 @@ Within testing framework ], ]; -#. Add API +#. Import the :php:`Codappix\Typo3PhpDatasets\TestingFramework` trait .. code-block:: php - use Codappix\Typo3PhpDatasets\TestingFramework; + use Codappix\Typo3PhpDatasets\TestingFramework as PhpDatasets; + + final class MyTest extends FunctionalTestCase + { + use PhpDatasets; + + // ... + } #. Use API