[Documentation] Types Cleanup #6341
Conversation
... in favor of https://www.doctrine-project.org/projects/doctrine-dbal/en/3.8/reference/types.html#reference Page: https://www.doctrine-project.org/projects/doctrine-orm/en/2.19/reference/basic-mapping.html#doctrine-mapping-types As announced in doctrine/dbal#6336 (comment) , the goal is to remove this duplicated type information from ORM and replace it with a link to DBAL. In doctrine/dbal#6341 , I'm adding any detail which I'm deleting here to the DBAL.
... in favor of https://www.doctrine-project.org/projects/doctrine-dbal/en/3.8/reference/types.html#reference Page: https://www.doctrine-project.org/projects/doctrine-orm/en/2.19/reference/basic-mapping.html#doctrine-mapping-types As announced in doctrine/dbal#6336 (comment) , the goal is to remove this duplicated type information from ORM and replace it with a link to DBAL. In doctrine/dbal#6341 , I'm adding any detail which I'm deleting here to the DBAL.
... in favor of https://www.doctrine-project.org/projects/doctrine-dbal/en/3.8/reference/types.html#reference Page: https://www.doctrine-project.org/projects/doctrine-orm/en/2.19/reference/basic-mapping.html#doctrine-mapping-types As announced in doctrine/dbal#6336 (comment) , the goal is to remove this duplicated type information from ORM and replace it with a link to DBAL. In doctrine/dbal#6341 , I'm adding any detail which I'm deleting here to the DBAL.
|
Please squash the commits like you did in doctrine/orm#11384 |
|
OK, done :-) |
| @@ -369,7 +370,7 @@ real arrays or JSON format arrays. | |||
| array | |||
| ^^^^^ | |||
|
|
|||
| Maps and converts array data based on PHP serialization. | |||
| Maps and converts array data using PHP's ``serialize()`` and ``unserialize()``. | |||
There was a problem hiding this comment.
Implementation details don't belong into a documentation.
There was a problem hiding this comment.
In this case it's an added benefit, cause if somebody has questions about some details, they can just find out what serialize() and unserialize() are doing exactly.
There was a problem hiding this comment.
Don't overload the reader with technicalities in the first sentence then. Maybe just add a like to PHP docs at the end of this section for futher reading.
There was a problem hiding this comment.
Well, in this case the only thing that's really important is the deprecation ;-) So I moved it upwards now.
BTW: This link is not working: :ref:\json``, see https://www.doctrine-project.org/projects/doctrine-dbal/en/3.8/reference/types.html#array - do you know how to fix it? (There are more occurrences on the page)
| Maps and converts array data based on PHP comma delimited imploding and exploding. | ||
| Maps and converts array data using PHP's ``implode()`` and ``explode()``, with a comma as delimiter | ||
| (so only use this type if you are sure that your values cannot contain a ``,``). |
There was a problem hiding this comment.
Again: implementation details!
There was a problem hiding this comment.
Here, the rather non-saying term "imploding and exploding" is repeated twice in the paragraph ;-)
Please leave the `implode()andexplode()`` in for now, so I don't forget it.
I will go over this page again (e.g. remove the phrase "Maps and converts" which is repeated all over), but I need to see it live - can't do this here on GitHub.
Besides, the main problem on this page IMO is the out-of-bounds "Mapping Matrix".
Co-authored-by: Alexander M. Turek <me@derrabus.de>
|
All I did in this PR was adding some details that were present in the ORM docs, but were deleted in doctrine/orm#11384 |
Page: https://www.doctrine-project.org/projects/doctrine-dbal/en/3.8/reference/types.html#reference
This PR is the "sibling" of doctrine/orm#11384