Issue #14567 has been updated by zverok (Victor Shepelev).


@Eregon, 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?

----------------------------------------
Misc #14567: Clarify YAML docs
https://bugs.ruby-lang.org/issues/14567#change-70751

* Author: zverok (Victor Shepelev)
* Status: Closed
* Priority: Normal
* Assignee: Eregon (Benoit Daloze)
----------------------------------------
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](https://docs.ruby-lang.org/en/2.5.0/YAML.html), 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)


-- 
https://bugs.ruby-lang.org/

Unsubscribe: <mailto:ruby-core-request / ruby-lang.org?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>