From: "Eregon (Benoit Daloze)" <redmine@...>
Date: 2013-04-28T22:13:21+09:00
Subject: [ruby-core:54658] [ruby-trunk - Bug #8213] No documentation for `ri YAML`


Issue #8213 has been updated by Eregon (Benoit Daloze).


zzak (Zachary Scott) wrote:
> @nobuhiro-san Thank you, I'm sorry for this mistake. Please check it now after r40509

Is there not a way to tell rdoc to document the YAML module without declaring it in the code?
The "if false" just looks messy to me.
----------------------------------------
Bug #8213: No documentation for `ri YAML`
https://bugs.ruby-lang.org/issues/8213#change-38998

Author: injekt (Lee Jarvis)
Status: Closed
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version: current: 2.1.0
ruby -v: 2.0.0-p0
Backport: 


I believe the RI output for YAML needs to be fixed to display more detailed information on usage. Currently, it displays nothing. I'm happy to start some documentation on the YAML const in lib/yaml.rb with any pointers in the right direction. View below for more information:

$ ri YAML # Ruby 1.9

= YAML

(from ruby core)
------------------------------------------------------------------------------
The YAML module allows you to use one of the two YAML engines that ship with
ruby.  By default Psych is used but the old and unmaintained Syck may be
chosen.

See Psych or Syck for usage and documentation.

To set the YAML engine to syck:

  YAML::ENGINE.yamler = 'syck'

To set the YAML engine back to psych:

  YAML::ENGINE.yamler = 'psych'
------------------------------------------------------------------------------
= Constants:

ENGINE:
  Allows changing the current YAML engine.  See YAML for details.

$ ri YAML # Ruby 2.0.0 (and trunk)
= YAML

------------------------------------------------------------------------------
Also found in:
  ruby core


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