8000 [PHPUnit bridge] Add documentation for the component by theofidry · Pull Request #6273 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[PHPUnit bridge] Add documentation for the component #6273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 15 commits into from
Closed

[PHPUnit bridge] Add documentation for the component #6273

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
05316b5
Add doc for the PHPUnit bridge component
theofidry Feb 15, 2016
5fe6bf0
Fix linting
theofidry Feb 15, 2016
eb27c9b
Various fix
theofidry Feb 15, 2016
ab94ab8
Update
theofidry Feb 17, 2016
891d2ff
minor fixes
theofidry Feb 17, 2016
a912299
Add SYMFONY_DEPRECATIONS_HELPER feature
theofidry Feb 27, 2016
cf8b0c4
Address some comments
theofidry Feb 27, 2016
d38454b
minor fixes
theofidry Feb 27, 2016
bfe2e76
Add link for @-silence operator
theofidry Feb 27, 2016
d5f7395
Drop 'Component' from the name
theofidry Feb 27, 2016
54001a8
Add doc for the ClockMock
theofidry Feb 27, 2016
57a1ce1
Fix typo in intro
theofidry Feb 27, 2016
4a5c951
Fix @xabbuh comments
theofidry Feb 27, 2016
8b29f89
Enhance clock mocking doc
theofidry Mar 1, 2016
d7c2adc
typo
theofidry Mar 4, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
minor fixes
  • Loading branch information
@theofidry
theofidry committed Feb 17, 2016
commit 891d2ff4d84fe360c4a0e181b666a6f88e69ab4c
6 changes: 3 additions & 3 deletions components/phpunit_bridge.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ It comes with the following features:

* Forces the application to use the default language locale for output (set the
locale to ``C``)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about changing this to: "Forces the tests to use a consistent locale (C)"

* Auto-register `class_exists` to load Doctrine annotations (when used)
* Auto-register ``class_exists`` to load Doctrine annotations (when used)
* It displays the whole list of deprecated features used in the application
* Display the stack trace of a deprecation on-demand.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Displays


Expand All @@ -32,7 +32,7 @@ Usage

Once the component installed, it automatically registers a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's simplify this:

Once the component installed, it automatically registers a
`PHPUnit event listener`_. This listener simply registers a `PHP error handler`_
called `DeprecationErrorHandler`.

by this:

Once the component installed, it automatically registers a
`PHPUnit event listener`_ which in turn registers a `PHP error handler`_
called `DeprecationErrorHandler`.

`PHPUnit event listener`_ which in turn registers a `PHP error handler`_
called `DeprecationErrorHandler`. After running your PHPUnit tests again, you
called ``DeprecationErrorHandler``. After running your PHPUnit tests again, you
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove "again" here

will get a report similar to this one:

.. image:: /images/components/phpunit_bridge/report.png
Expand Down Expand Up @@ -75,7 +75,7 @@ Configuration
In case you need to inspect the stack trace of a particular deprecation
triggered by your unit tests, you can set the ``SYMFONY_DEPRECATIONS_HELPER``
`environment variable`_ to a regular expression that matches this deprecation's
message, encapsed between `/`. For example, with:
message, encapsed between ``/``. For example, with:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[...] enclosed with / [...]


.. configuration-block::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

YOu can remove this directive (it's only used when showing multiple formats of the same config, but PHPunit only supports XML)


Expand Down
0