Skip to content

Document Psych.dump options#351

Merged
hsbt merged 1 commit intoruby:masterfrom
zverok:document-options
Mar 23, 2018
Merged

Document Psych.dump options#351
hsbt merged 1 commit intoruby:masterfrom
zverok:document-options

Conversation

@zverok
Copy link
Copy Markdown
Contributor

@zverok zverok commented Mar 2, 2018

Psych.dump options aren't documented anywhere, even despite the fact that there is an explicit reference to those non-existent docs in Object#to_yaml:

See Psych.dump for more information on the available options.

I hope that I've extracted all possible options and their meaning from code correctly. The one option that intently left undocumented is :version, because currently, it seems to accept exactly one "correct" value: "1.1", which is also the default value.

Rendered docs screenshot in default RDOC template:

image

BTW, shouldn't those options be turned into keyword arguments already? .load has keyword arguments, which is inconsistent with .dump.

@hsbt
Copy link
Copy Markdown
Member

hsbt commented Mar 23, 2018

Thank you!

@hsbt hsbt merged commit 6129f56 into ruby:master Mar 23, 2018
@zverok zverok deleted the document-options branch November 14, 2018 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants