Project

General

Profile

Misc #14567

Clarify YAML docs

Added by zverok (Victor Shepelev) about 2 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Normal
[ruby-core:85890]

Description

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.


Files

yaml-docs.patch (607 Bytes) yaml-docs.patch zverok (Victor Shepelev), 03/02/2018 12:43 PM

Updated by Eregon (Benoit Daloze) about 2 years ago

  • Assignee set to Eregon (Benoit Daloze)

Sounds good to me, I'll commit it.

#2

Updated by Eregon (Benoit Daloze) about 2 years ago

  • 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

Updated by zverok (Victor Shepelev) about 2 years ago

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?

Updated by Eregon (Benoit Daloze) about 2 years ago

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 :)

Also available in: Atom PDF