From: Andrew Grimm <andrew.j.grimm@...>
Date: 2011-08-22T08:36:51+09:00
Subject: [ruby-core:39040] [Ruby 1.9 - Bug #5210][Open] Kernel#require documentation is incomplete


Issue #5210 has been reported by Andrew Grimm.

----------------------------------------
Bug #5210: Kernel#require documentation is incomplete
http://redmine.ruby-lang.org/issues/5210

Author: Andrew Grimm
Status: Open
Priority: Normal
Assignee: 
Category: 
Target version: 
ruby -v: ruby 1.9.1p378 (2010-01-10 revision 26273) [i386-mingw32]


The documentation for Kernel#require could benefit from additional description.

It does not describe what a return method of false means. Many people initially think that a return value of false means that the require method was unsuccessful. See, for example, http://stackoverflow.com/q/1250329/38765 and http://stackoverflow.com/q/1793693/38765 . So explaining that it merely means that the library has already been loaded would be useful.

Mentioning that a LoadError is raised if unsuccessful would also be nice.

As a side issue, "it's" is used when it should be "its". The former means "it is", while the latter mean "something belonging to it".


-- 
http://redmine.ruby-lang.org