Examples are confusing

[vchekan]

I like the idea of pickling library very much, but the problem with documentation is not lack of it, but confusing examples and structure.

I believe usage example should look like this: http://stackoverflow.com/a/23091338/158913 because serialization library examples can not be demonstrated without converting objects to string and from string to object. Current examples fail to demonstrate how to get string from object. It also fails to demonstrate how to get object from string. So it fail to demonstrate the very essence of (de)serialization.

Regarding documentation structure, I'd go with showing use cases in increasing complexity order. Start with base types serialization, than containers (arrays, lists, maps, etc), than user types with simple properties, than nested types, than customization of pickles, etc. And introduce internals of pickling library on "as needed" basic. I've watched presentation, and if all internals are shown at once, it is difficult to understand it.

Hope this opinion helps, macros plus static serialization is the way to go, thanks for implementing it!

[jsuereth]

FYI - This is a good suggestion, I'm going to try to see if I can coordinate getting documentation together and start up a legit user's guide.