Place a warning about the uses of traits in the documentation #10393
Conversation
| There is no real "official" statement whether or to which extent traits | ||
| are supported in entity or mapped superclasses. | ||
|
|
||
| Traits were added in PHP 5.4 more than 10 years ago, but at the same time |
| :doc:`overriding field association mappings in subclasses <tutorials/override-field-association-mappings-in-subclasses>`. Also, the | ||
| tests in the ORM codebase (as of writing) cover traits only in two (!) places, | ||
| namely the aforementioned override and in an edge-case for the deprecated | ||
| "Entity Generator". |
There was a problem hiding this comment.
This paragraph is going to be hard to maintain: we will have to remember to remove this reference to "Entity Generator" when merging up to 3.0.x, and to change it any time we add any thing about traits in the docs. Maybe you should be more vague here?
| namely the aforementioned override and in an edge-case for the deprecated | ||
| "Entity Generator". | ||
| namely the aforementioned override and in an edge-case for a tool that will be | ||
| removed in Doctrine 3.0. |
There was a problem hiding this comment.
I would replace the whole paragraph with "In fact, traits are rarely mentioned in the docs or in the tests. That way there is no divergence between branches.
| There is no real "official" statement whether or to which extent traits | ||
| are supported in entity or mapped superclasses. |
There was a problem hiding this comment.
But since this is the official documentation, we're about to make an official statement, aren't we? I find this paragraph irritating.
There was a problem hiding this comment.
You’re right.
So, what can we say?
“For the time being, traits are not officially supported.” ?
|
Updated text suggestions, please 👀 |
mpdude
force-pushed
the
traits-warning
branch
from
1329296 to
853e80c
Compare
|
Thanks @mpdude ! |
I am not sure if all this is 💯 correct, but I'd be happy to learn.