Project

General

Profile

Bug #8778

lib/test/ documentation is too weak

Added by zzak (Zachary Scott) almost 7 years ago. Updated almost 7 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
ruby -v:
2.1.0dev
[ruby-core:56562]

Description

sora-san when you are well-fed and well-rested: what do you propose for lib/test/ documentation?

I suggest 'nodoc' the majority of it adding a note about 'compatibility layer' to top-level module.

However, I realize there may be some test-unit users still.

I am willing to document existing functionality of lib/test/ if 'nodoc' is rejected.

Using RDoc: I have generated a coverage report of current lib/test/: https://gist.github.com/zzak/6208031


Files

Updated by zzak (Zachary Scott) almost 7 years ago

  • Description updated (diff)

Updated by sorah (Sorah Fukumori) almost 7 years ago

Sorry for late reply,

This is okay for me, if there is no objection.

Does anyone have objection for this?

Updated by steveklabnik (Steve Klabnik) almost 7 years ago

I have attached a patch that will do this. If there is no objection, please feel free to apply it. :)

#4

Updated by zzak (Zachary Scott) almost 7 years ago

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

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


  • lib/test/: [DOC] Document Test::Unit, hide most submodules and classes from rdoc. Since lib/test is only present as a compatibility layer with the legacy test suite many test/unit users will be using minitest or the test/unit gem instead. It is recommended to use one of these alternatives for writing new tests.

This patch was based on a patch submitted by Steve Klabnik.
[ruby-core:56694] [Bug #8778]

Also available in: Atom PDF