added documentation for the new Debug component #2479
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
fabpot
commented
Apr 7, 2013
fabpot
commented
| Q | A |
|---|---|
| Doc fix? | no |
| New docs? | yes (symfony/symfony#7441) |
| Applies to | 2.3+ |
| Fixed tickets | n/a |
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Apr 7, 2013
This PR was merged into the master branch. Discussion ---------- [Debug] added the component (closes #6828, closes #6834, closes #7330) | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #6828, #6834, #7330 | License | MIT | Doc PR | symfony/symfony-docs#2479 You can use the individual tools, or register them all: ```php use Symfony\Component\Debug\Debug; Debug::enable(); ``` Changes in Symfony SE: symfony/symfony-standard#523 Commits ------- f693128 fixed typos 1ab1146 [Debug] fixed minor bugs daa3a3c [Debug] changed composer to accept more versions e455269 [Debug] ensured that the Debug tools can only be registered once 946bfb2 [Debug] made the exception handler independant of HttpFoundation 2b305c2 added a main Debug class to ease integration 2ff0927 [Debug] added the component (closes #6828, closes #6834, closes #7330)
| Debug::enable(); | ||
|
|
||
| The :method:`Symfony\\Component\\Debug\\Debug::enable` method registers an | ||
| error handler and an exception handler. If the Symfony ClassLoader component |
There was a problem hiding this comment.
add some interlinking to the ClassLoader component docs here.
|
you forgot to add this article in the |
| The Debug Component | ||
| =================== | ||
|
|
||
| The Debug Component provides tools to ease debugging PHP code. |
There was a problem hiding this comment.
You should add the note saying it is new in 2.3, extracting code from HttpKernel (see how it is done for PropertyAccess)
|
everything should be ok now. |
|
|
||
| The :method:`Symfony\\Component\\Debug\\Debug::enable` method registers an | ||
| error handler and an exception handler. If the :doc:`ClassLoader component | ||
| </components/class_loader>` is available, a special class loader is also |
There was a problem hiding this comment.
I prefer to have rules on 1 line:
[...] If the
:doc:`ClassLoader component </components/class_loader>` is available,
a special [...]There was a problem hiding this comment.
That's not what we are doing elsewhere. I don't format things by hand but via my text editor.
There was a problem hiding this comment.
It's something I always say on PRs and it's something that's done in all documents as far as I can see.
There was a problem hiding this comment.
ok, I will let you reformat what you think is best.
weaverryan
added a commit
that referenced
this pull request
Apr 11, 2013
added documentation for the new Debug component
weaverryan
added a commit
that referenced
this pull request
Apr 11, 2013
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.