Project

General

Profile

Actions
Copy link

Bug #8213

closed

No documentation for `ri YAML`

Added by injekt (Lee Jarvis) over 11 years ago. Updated over 11 years ago.

Status:
Closed
Assignee:
zzak (zzak _)
Target version:
2.1.0
ruby -v:
2.0.0-p0
Backport:
[ruby-core:53965]

Description

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

Actions
Copy link

Also available in: Atom PDF

Like0
Like0Like0Like0Like0Like0Like0Like0