Updated docs added missing use statements #194
Conversation
|
These use statements arent actually used. Can you change the phpdoc to point to the full class name instead? |
|
well it's true that it will work without those (meaning it's only a fix for the phpdoc) so it's not like it's really important but then the phpdoc is wrong I could use the full class name in the phpdoc but that's against the symfony coding standards... |
|
The coding standards documentation does not talk about this, and it doesnt make sense to import a php class just for use in a phpdoc comment. |
|
This issue doesnt need Stof's blessing, its rather simple - example documentation for entities is not very important and I'm not happy to import classes for use in phpdoc. |
|
Well most people copy paste that example. But I agree. I didn't expect this discussion either. It already took me longer then I thought to pull request this. (having to triple check things). But I would still like to hear his answer if he reads this. Not to prove anyone wrong (because it is not written in the docs so you are right about that) but just to know if there is a guideline for that. Because I thought there was. I'll update this request in the coming days and then you can merge this. Or just close it if you see it as a non issue. |
| @@ -32,6 +32,9 @@ namespace Acme\MessageBundle\Entity; | |||
| use Doctrine\ORM\Mapping as ORM; | |||
| use Doctrine\Common\Collections\ArrayCollection; | |||
| use FOS\MessageBundle\Entity\Message as BaseMessage; | |||
| use FOS\MessageBundle\Model\ThreadInterface; | |||
| use FOS\MessageBundle\Entity\MessageMetadata; | |||
There was a problem hiding this comment.
Maybe unneeded if class is created in same namespace then it would reference the class the user has created
|
Ok I finally wanted to fix it the way you proposed. But then I saw There the use statements also get used only for the vars. So you want me to remove those then? I don't see anything wrong with adding use statements for interfaces. There can be problems with it for classes though Miliooo@26499ef caused doctrine problems 👎. (guess I learned something from this pull request |
)
|
Any imported class purely for phpdoc reasons should be removed and replaced with a full class name. |
Updated docs added missing use statements
There are some use statements missing for the @ var