Misc #14567: Clarify YAML docs

• Status: Closed
• Assignee: Eregon (Benoit Daloze)

[zverok (Victor Shepelev)]

The problem I am trying to solve: If you try to understand what methods do YAML have, and what parameters, say, YAML.load_file accept, the "official" docs look pretty unhelpful, saying, basically "This is not the docs you are looking for".

The Psych library is mentioned and even hyperlinked, yet it mentioned as an "underlying implementation", like "something low-level that helps stdlib's YAML to do the job, don't think about Psych".

So, I felt it as a necessity to add a clarification that Psych, in fact, IS YAML, and all options and methods are documented there.

[Eregon (Benoit Daloze)]

• Assignee set to Eregon (Benoit Daloze)

Sounds good to me, I'll commit it.

[Eregon (Benoit Daloze)]

• Status changed from Open to Closed

Applied in changeset trunk|r62635.

---

Clarify the documentation of the YAML module [Misc #14567]

Based on a patch from Victor Shepelev

[Eregon (Benoit Daloze)]

@zverok (Victor Shepelev) Thank you for the patch!

[zverok (Victor Shepelev)]

@Eregon (Benoit Daloze), thanks for merging!

BTW, as we are here, I have posted several doc.patches lately, and they had no reactions:
https://bugs.ruby-lang.org/issues/14483
https://bugs.ruby-lang.org/issues/14450
https://bugs.ruby-lang.org/issues/14436

I wonder if that means I should just wait because nobody had enough time to look at them, or that there are some problems with proposed documentation changes?

[Eregon (Benoit Daloze)]

I'd guess nobody took the time to look at them yet.
I think it's OK to post a new message on those issue asking for to review the changes and commit them.

I wanted to merge this one as I remember being confused by the YAML docs as well :)