[HttpFoundation] Improve phpdoc #18442
Closed
Conversation
This file contains hidden or 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
Improve the phpdoc for the `$default` parameter of the `get()` method. It wasn't clear when the default value would be used (whether the key would not exist or the value was `null` or nullish). The comment is now in sync with `Symfony\Component\HttpFoundation\ParameterBag::get()`.
|
👍 (should be merged into the Status: Reviewed |
|
In case you accept suggestions for the new doc, what about changing this: by this: |
|
@javiereguiluz 👍 how about this:
? |
|
Thank you @mnapoli. |
nicolas-grekas
added a commit
that referenced
this pull request
Apr 5, 2016
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #18442). Discussion ---------- [HttpFoundation] Improve phpdoc | Q | A | ------------- | --- | Branch? | master? | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Improve the phpdoc for the `$default` parameter of the `get()` method. It wasn't clear when the default value would be used (whether the key would not exist or the value was `null` or nullish). The comment is now in sync with `Symfony\Component\HttpFoundation\ParameterBag::get()`. Commits ------- 6bfbb2e [HttpFoundation] Improve phpdoc
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.
Improve the phpdoc for the
$defaultparameter of theget()method. It wasn't clear when the default value would be used (whether the key would not exist or the value wasnullor nullish).The comment is now in sync with
Symfony\Component\HttpFoundation\ParameterBag::get().