Bug #4693: Documentation for YAML::DBM and YAML::Store

• Status: Closed
• Assignee: drbrain (Eric Hodel)
• Target version: 1.9.3
• ruby -v: -

[jsc (Justin Collins)]

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.

[drbrain (Eric Hodel)]

• 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

[drbrain (Eric Hodel)]

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.