Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Options to Psych.dump are undocumented #52

Closed
Phrogz opened this Issue · 3 comments

3 participants

@Phrogz

http://stackoverflow.com/questions/9759302/documentation-for-psych-to-yaml-options

Are the functions in emitter.c the only options supported? Can documentation for these options be moved into the rb for dump so they're accessible? And then get any reasonably documented version described on ruby-doc.org?

@tenderlove
Owner

options is kind of overloaded, as it's also used when building the tree. If you send a documentation pull request, I'll be happy to apply it.

Unfortunately I have no control over the documentation posted on ruby-doc.org. :(

@zzak
Collaborator

@tenderlove Should these be documented on psych/emitter.c?

@tenderlove
Owner

Well, emitter.c doesn't actually take hash parameters as options. You have to give it a configuration object.

If you do an ri Psych.dump the options do show up:

ri info

All of the options on Psych::Emitter should be documented as well. I'm closing this ticket since I have no control over the documentation available on ruby-doc.org, but any documentation patches would be gladly accepted!

@tenderlove tenderlove closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.