media-io / yaserde

Yet Another Serializer/Deserializer
MIT License
179 stars 60 forks source link

Initial serialize documentation and moving examples #106

Closed brainstorm closed 3 years ago

brainstorm commented 3 years ago

Showcasing XML attributes and children. Left to document or fix are: dependencies and pretty-printing.

Hopefully fixes #55 and hopefully also fixes #22 properly since it's confusing for new users.

Needs help on: XML Prettyprinting, can @MarcAntoine-Arnaud assist? :)

coveralls commented 3 years ago

Pull Request Test Coverage Report for Build 261


Totals Coverage Status
Change from base Build 256: 0.0%
Covered Lines: 943
Relevant Lines: 1647

💛 - Coveralls
MarcAntoine-Arnaud commented 3 years ago

Showcasing XML attributes and children. Left to document or fix are: dependencies and pretty-printing.

Hopefully fixes #55 and hopefully also fixes #22 properly since it's confusing for new users.

Needs help on: XML Prettyprinting, can @MarcAntoine-Arnaud assist? :)

Thank for this PR ! Not problem to help you, but what do you mean by XML Prettyprinting ? Do you mean output XML with indent and returning lines ?

brainstorm commented 3 years ago

Not problem to help you, but what do you mean by XML Prettyprinting ? Do you mean output XML with indent and returning lines ?

Yeah, that, paste any one-line XML here:

https://developers.onelogin.com/saml/online-tools/xml-pretty-print

Just to avoid room for confusion... just indented and generally human-readable ;)

brainstorm commented 3 years ago

Thanks for merging but I think you merged it too soon? There’s still a couple of issues to fix in the docs (see above in the thread):

1) Substitute the pretty printing comment in capitals (after we find a working solution). 2) Dependency clarifications comments in docs too.