[PropertyInfo] Document setting serializer_groups to null in the SerializerExtractor #13825
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
components/property_info.rst
Outdated
|
|
||
| .. note:: | ||
|
|
||
| The `serializer_groups` option must be provided in order to have a value different than `null` returned. |
There was a problem hiding this comment.
A minor thing. I know it's annoying, but RST format is a bit different than Markdown for code. All single backticks must be double backticks:
`serializer_groups` -> ``serializer_groups``
There was a problem hiding this comment.
Oh right, thanks :) I've been fooled by the single backtick for links 😅
wouterj
approved these changes
Oct 17, 2020
|
|
||
| .. note:: | ||
|
|
||
| The ``serializer_groups`` option must be provided in order to have a value different than ``null`` returned. |
There was a problem hiding this comment.
I would move this into a PHP comment in the above example:
- // List information.
+ // The `serializer_groups` option must be configured (may be set to null)
Comment on lines
+448
to
+445
| If ``serializer_groups`` is set to ``null``, serializer groups metadata won't be checked but you will get only the properties | ||
| considered by the Serializer Component (notably the ``@Ignore`` annotation is taken into account). |
There was a problem hiding this comment.
I think it's best to remove the .. note:: and make this a normal paragraph
Suggested change
| If ``serializer_groups`` is set to ``null``, serializer groups metadata won't be checked but you will get only the properties | |
| considered by the Serializer Component (notably the ``@Ignore`` annotation is taken into account). | |
| If ``serializer_groups`` is set to ``null``, serializer groups metadata won't be checked but you | |
| will get only the properties considered by the Serializer Component (notably the ``@Ignore`` | |
| annotation is taken into account). |
4b82683 to
3781df6
Compare
|
Thanks Guilhem! @wouterj I did the changes you proposed while merging. |
|
My bad, I forgot to update my PR to take into account @wouterj suggestions after reading the notification... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes #13793 :)
If you'd like I can backport the part about
serializer_groupsbegin mandatory in order to use theSerializerExtractor.