Bug #4709

Revise documentation for Singleton

Added by Pete Higgins almost 3 years ago. Updated almost 3 years ago.

[ruby-core:36223]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:doc
Target version:-
ruby -v:ruby 1.9.3dev (2011-05-16 trunk 31588) [x86_64-linux] Backport:

Description

Singleton seemed to be light on documentation, and it included some non-working example code that seemed to function as documentation and tests. In addition, a few classes and methods in the example code were picked up by Rdoc.

The first patch:
- Removes the example code.
- Revises the documentation.

The second patch:
- Adds some basic tests for Singleton.

singleton_docs.diff Magnifier (9.97 KB) Pete Higgins, 05/16/2011 05:10 PM

singleton_tests.diff Magnifier (2.39 KB) Pete Higgins, 05/16/2011 05:10 PM

Associated revisions

Revision 31613
Added by Eric Hodel almost 3 years ago

  • lib/singleton.rb: Improve documentation. Patch by Pete Higgins. [Ruby 1.9 - Bug #4709]

History

#1 Updated by Eric Hodel almost 3 years ago

Can you split the tests change into a separate issue?

#2 Updated by Pete Higgins almost 3 years ago

I moved the tests into their own issue: http://redmine.ruby-lang.org/issues/4715

#3 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 r31613.
Pete, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • lib/singleton.rb: Improve documentation. Patch by Pete Higgins. [Ruby 1.9 - Bug #4709]

Also available in: Atom PDF