From 464c078d3c92f03c7292b575df249071b7f5d4af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Mon, 29 Jan 2018 20:02:04 +0100 Subject: [PATCH] Add a table to summarize the modes --- components/phpunit_bridge.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/components/phpunit_bridge.rst b/components/phpunit_bridge.rst index f50a3b760d6..7323d6242e1 100644 --- a/components/phpunit_bridge.rst +++ b/components/phpunit_bridge.rst @@ -200,6 +200,26 @@ the ``vendors`` directory will make the test suite fail, while deprecations triggered from a library inside it will not, giving you the best of both worlds. +Here is a summary that should help you pick the right mode: + ++----------------+-----------------------------------------------------+ +| Mode | Recommended situation | ++================+=====================================================+ +| strict | Recommended for actively maintained projects | +| | with little to no dependencies | ++----------------+-----------------------------------------------------+ +| | Recommended for projects that you cannot | +| | immediately fix but don't want to make worse. | +| | Can be used to transition from one mode to another. | ++----------------+-----------------------------------------------------+ +| weak_vendors | Recommended for libraries that use | +| | the deprecation system themselves and | +| | cannot afford to use one of the modes above. | ++----------------+-----------------------------------------------------+ +| weak | Not recommended; will probably lead to | +| | a big refactoring. | ++----------------+-----------------------------------------------------+ + Disabling the Deprecation Helper ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~