[DoctrineBridge] Fixed php doc #19410
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
Contributor
| Q | A |
|---|---|
| Branch? | 2.7 |
| Bug fix? | yes |
| New feature? | no |
| BC breaks? | no |
| Deprecations? | no |
| Tests pass? | yes |
| Fixed tickets | ~ |
| License | MIT |
| Doc PR | ~ |
Contributor
|
See fabbot CS failures |
Contributor
Author
|
Done |
| * hold the manager name. | ||
| * @param string $driverPattern Pattern for the metadata driver service name | ||
| * @param string $enabledParameter Service container parameter that must be | ||
| * @param bool $enabledParameter Service container parameter that must be |
Member
There was a problem hiding this comment.
This is wrong. $enabledParameter is the parameter name (a string) or false.
Contributor
Author
There was a problem hiding this comment.
@Tobion, false is not valid for this place in PHPdoc. In this place we must specify variable type but not specific value. I think correct is 'string|bool'.
Contributor
There was a problem hiding this comment.
of course is false a valid value. See phpdoc documentation.
Contributor
Author
|
@Tobion, @nicolas-grekas, sorry, I was wrong. Replaced it by 'string|false'. |
| * @param string $cacheName The cache driver name | ||
| * @param string $objectManagerName The object manager name | ||
| * @param array $cacheDriver The cache driver mapping | ||
| * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container The ContainerBuilder instance |
Member
There was a problem hiding this comment.
hum while we're at it, this could be changed to
@param ContainerBuilder ...
Contributor
Author
There was a problem hiding this comment.
Ok, I will fix it now.
Member
|
Thank you @zomberg. |
nicolas-grekas
added a commit
that referenced
this pull request
Jul 26, 2016
This PR was squashed before being merged into the 2.7 branch (closes #19410). Discussion ---------- [DoctrineBridge] Fixed php doc | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | ~ | License | MIT | Doc PR | ~ Commits ------- b2d25f4 [DoctrineBridge] Fixed php doc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.