Skip to content

addressed issue #11786 #13269

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

Merged
merged 1 commit into from
Nov 5, 2020
Merged

addressed issue #11786 #13269

merged 1 commit into from
Nov 5, 2020

Conversation

armin-github
Copy link
Contributor

The following issue has been addressed: Repeated entry in the Serializer components doc #11786
The separate documentations for XMLEncoder were put into one section with minor changes in text. The documentation now contains one single section for XMLEncoder.

@armin-github
Copy link
Contributor Author

In the patch: the title 'The Context parameter of XmlEncoder' will probably need to be entirely underlined with the correct markup (~~~~~~~~~~~~~~~~~~), so the markup test will pass.

@OskarStark
Copy link
Contributor

Thanks for your contribution, however I am unable to see the real difference, as most of the content is just moved around.

Can you please point me to the lines which makes sth more clear than before? Thanks

@armin-github
Copy link
Contributor Author

Sure!
The original issue (#11786) point out the repeated entry regarding XMLEncoder in the documentation. The original documentation is split regarding this into two separate sections which is indeed confusing. what I have done is basically merging the two sections into one in an order that is now easier to follow for the reader.

The following issue has been addressed: Repeated entry in the Serializer components doc symfony#11786
The separate documentations for XMLEncoder were put into one section with minor changes in text. The documentation now contains one single section for XMLEncoder.
@wouterj wouterj changed the base branch from 5.0 to 4.4 November 5, 2020 17:16
@wouterj
Copy link
Member

wouterj commented Nov 5, 2020

Hi @armin-github! I'm very sorry for the long wait, I'm not sure why we've missed this. The PR makes a lot of sense, the duplicate sections should indeed be merged.

@wouterj wouterj merged commit cf34c42 into symfony:4.4 Nov 5, 2020
wouterj added a commit that referenced this pull request Nov 8, 2020
…a table (wouterj)

This PR was merged into the 4.4 branch.

Discussion
----------

[Serializer] Merge encoder sections and show options in a table

While merging #13269 , I found that we also documented CsvEncoder options in a different section. This merges both duplicated sections.

I've also transformed them to a table, similar to the recent changes to documenting the provider options in the Messenger guide.

Commits
-------

d397c38 Merge encoder sections and show options in a table
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.

4 participants