Project

General

Profile

Actions
Copy link

Bug #4709

closed

Revise documentation for Singleton

Bug #4709: Revise documentation for Singleton

Added by phiggins (Pete Higgins) over 14 years ago. Updated over 14 years ago.

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

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.

Files

Download all files
singleton_docs.diff (9.97 KB) singleton_docs.diff phiggins (Pete Higgins), 05/16/2011 05:10 PM
singleton_tests.diff (2.39 KB) singleton_tests.diff phiggins (Pete Higgins), 05/16/2011 05:10 PM

Updated by drbrain (Eric Hodel) over 14 years ago Actions
Copy link
 #1 [ruby-core:36233]

Can you split the tests change into a separate issue?

Updated by drbrain (Eric Hodel) over 14 years ago Actions
Copy link
 #3

  • 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]
Actions
Copy link

Also available in: PDF Atom