Bug #5210

Kernel#require documentation is incomplete

Added by agrimm (Andrew Grimm) almost 9 years ago. Updated almost 9 years ago.

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, and . 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".

Updated by drbrain (Eric Hodel) almost 9 years ago

  • Category set to doc
  • Assignee set to drbrain (Eric Hodel)

Updated by drbrain (Eric Hodel) almost 9 years ago

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

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

  • load.c (rb_f_require): Improve documentation of Kernel#require. [Ruby 1.9 - Bug #5210]

Also available in: Atom PDF