Documentation!

[connec]

The library is currently mostly undocumented. The PyYAML documentation is useful for reference on the general structure of the API, however some library-specific documentation is urgently required.

[kevin-smets]

Will there be docs for using the parsers? Right now it's rather unclear what is the output for every variation. One emits events, the other tokens, but there does not seem to be a clear structure to this (or at least, I haven't found one immediately).

[connec]

You're right, the documentation is very lacking. I'm trying to find time to give this repo some much needed TLC, but there is a summary of what each of the main API methods return in the README, here.

[Asuza]

Any updates on the documentation? I'm having trouble following the code to understand what's going on, and was hoping to use this module to load two yaml files (preferably by merging them together, if possible).

[connec]

I'm going to close this since the repository is going to be archived. yaml-js has been unmaintained for some time, so it would be best to use something else.