Bug #4693

Documentation for YAML::DBM and YAML::Store

Added by Justin Collins almost 3 years ago. Updated almost 3 years ago.

[ruby-core:36182]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:doc
Target version:1.9.3
ruby -v:- Backport:

Description

Docs for lib/yaml/dbm.rb and lib/yaml/store.rb

Side note: I'm guessing the split of Syck/Psych has somehow lost the documentation for the YAML library itself? Something should be added to lib/yaml.rb to point people to the right place, but I don't know where that would be.

0001-Documentation-for-YAML-DBM.patch Magnifier (6.12 KB) Justin Collins, 05/14/2011 06:18 AM

0001-Documentation-for-YAML-Store.patch Magnifier (1.78 KB) Justin Collins, 05/14/2011 06:18 AM

Associated revisions

Revision 31559
Added by Eric Hodel almost 3 years ago

  • lib/yaml/dbm.rb: Add documentation. Patch by Justin Collins. [Ruby 1.9 - Bug #4693]
    • lib/yaml/store.rb: ditto

History

#1 Updated by Eric Hodel almost 3 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r31559.
Justin, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • lib/yaml/dbm.rb: Add documentation. Patch by Justin Collins. [Ruby 1.9 - Bug #4693]
    • lib/yaml/store.rb: ditto

#2 Updated by Eric Hodel almost 3 years ago

I fixed your example in YAML::Store as it didn't have enough indentation.

For future commits you can check your work by running rdoc --all -o /tmp/doc lib/yaml* and opening /tmp/doc/YAML/Store.html, for example.

It looks like the documentation visible from 1.8 has moved to ext/syck/lib/syck.rb but isn't being picked up properly.

Also available in: Atom PDF