Show a more real example in data collectors doc #5774
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
wouterj
commented
Oct 10, 2015
wouterj
commented
| Q | A |
|---|---|
| Doc fix? | yes |
| New docs? | no |
| Applies to | 2.3+ |
| Fixed tickets | - |
| * @param Request $request A Request instance | ||
| * @param Response $response A Response instance | ||
| * @param \Exception $exception An Exception instance | ||
| */ |
There was a problem hiding this comment.
Removed the PHPdoc as I don't think it's very usefull (short descriptions are better described directly after the code example and the typehint already shows which instances are passed).
In case people want to know the PHPdoc, they can now click on the API links below the example.
| properties. | ||
| The | ||
| :method:`Symfony\\Component\\HttpKernel\\DataCollector\\DataCollectorInterface::getName` | ||
| method returns the name of the data collector and must be unique in the |
There was a problem hiding this comment.
... unique within ... ?
There was a problem hiding this comment.
unique within data collector names. But yeah, the message could be improved
|
Status: Reviewed |
| <b>Another piece of data</b> | ||
| <span>300 units</span> | ||
| <b>Accepted content type</b> | ||
| <span>{{ collector.acceptablecontenttypes|join(', ') }}</span> |
There was a problem hiding this comment.
collector.acceptableContentTypes is more readable
|
This is so much better. Thanks for fixing my ridiculous example from many years ago - real examples ftw! |
weaverryan
added a commit
that referenced
this pull request
Nov 5, 2015
This PR was merged into the 2.3 branch. Discussion ---------- Show a more real example in data collectors doc | Q | A | --- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.3+ | Fixed tickets | - Commits ------- 5e2c1af Show a more real example in data collectors doc
weaverryan
added a commit
that referenced
this pull request
Nov 5, 2015
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.