Skip to content

Conversation

xElysioN
Copy link
Contributor

Hi,

The phpdoc of the variable $name was [@]param instead of [@]var. (Other variables don't have it, so i decide to remove it)
http://docs.phpdoc.org/references/phpdoc/tags/param.html

And add the phpdoc to removeOffer.

@teohhanhui
Copy link
Contributor

No. I think it's fine the way it is. 😄

@dunglas
Copy link
Member

dunglas commented Apr 12, 2018

The phpdoc of the variable $name was [@]param instead of [@]var. (Other variables don't have it, so i decide to remove it)

Good catch, but please keep it (just change @param in @var because this annotation is used to generate the public documentation.

And add the phpdoc to removeOffer.

Please remove it (according to our CS). The information is already provided by the typehint and adds nothing.

@teohhanhui
Copy link
Contributor

Oops. Yeah, I overlooked the typo lol...

@xElysioN
Copy link
Contributor Author

I remove the annotation in the removeOffer function and change param by var.

@meyerbaptiste meyerbaptiste merged commit 587530b into api-platform:2.2 Apr 13, 2018
@meyerbaptiste
Copy link
Member

Thanks @xElysioN!

@xElysioN xElysioN deleted the fix-phpdoc branch April 14, 2018 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants