diff options
author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2010-12-25 02:07:13 +0000 |
---|---|---|
committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2010-12-25 02:07:13 +0000 |
commit | d0830a222c261922cb73e340ae32bf6f32f6845e (patch) | |
tree | 7448edeccf2b73b12a60df2cda2346b5def0abad | |
parent | 91c6ba23336789f340878f69b5fee1defe0fa5d5 (diff) |
Document require_relative
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@30342 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r-- | ChangeLog | 4 | ||||
-rw-r--r-- | load.c | 10 |
2 files changed, 13 insertions, 1 deletions
@@ -1,3 +1,7 @@ +Sat Dec 25 11:06:00 2010 Eric Hodel <drbrain@segment7.net> + + * load.c (rb_f_require_relative): Add documentation. + Sat Dec 25 11:02:52 2010 Nobuyoshi Nakada <nobu@ruby-lang.org> * ext/zlib/zlib.c (gzreader_gets): support optional length @@ -453,7 +453,15 @@ rb_f_require(VALUE obj, VALUE fname) return rb_require_safe(fname, rb_safe_level()); } -VALUE +/* + * call-seq: + * require_relative(string) -> true or false + * + * Ruby tries to load the library named _string_ relative to the requiring + * file's path. If the file's path cannot be determined a LoadError is raised. + * If a file is loaded +true+ is returned and false otherwise. + */ + rb_f_require_relative(VALUE obj, VALUE fname) { VALUE rb_current_realfilepath(void); |