Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the implied 'Default' property group when no group is specified #661

Merged
merged 2 commits into from
Oct 28, 2016

Conversation

akoebbe
Copy link
Contributor

@akoebbe akoebbe commented Oct 25, 2016

Pretty sure the example code should be referencing details and not Default.

@goetas
Copy link
Collaborator

goetas commented Oct 25, 2016

Pay attention to https://github.com/schmittjoh/serializer/blob/master/src/JMS/Serializer/Exclusion/GroupsExclusionStrategy.php#L34

The documentation says that there is a Default group :)

@akoebbe
Copy link
Contributor Author

akoebbe commented Oct 25, 2016

@goetas Ah ha! Thanks for pointing that out. It wasn't apparent that the Default group existed. Where is that in the docs?

@goetas
Copy link
Collaborator

goetas commented Oct 25, 2016

i guess the document you tried to change, had the intent do document it :)

but an explicit section does not exists probably... interested in adding it?

@akoebbe
Copy link
Contributor Author

akoebbe commented Oct 25, 2016

Yup. I'll back out the last commit and add an explicit statement about it.

@akoebbe akoebbe changed the title Documentation fix for example exclusion group Document the implied 'Default' property group when no group is specified Oct 25, 2016
@akoebbe
Copy link
Contributor Author

akoebbe commented Oct 25, 2016

@goetas let me know if that is clear enough.

You can achieve that by using the ``@Groups`` annotation on your properties.
You can achieve that by using the ``@Groups`` annotation on your properties. Any
property without an explicit ``@Groups`` annotation will be included in a
``Default`` group, which can be used when specifying groups in the serializer.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"...groups in the serialization context." ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fine by me.

@goetas
Copy link
Collaborator

goetas commented Oct 25, 2016

thanks

@goetas goetas merged commit 2b77c52 into schmittjoh:master Oct 28, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants