From d0830a222c261922cb73e340ae32bf6f32f6845e Mon Sep 17 00:00:00 2001
From: drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Sat, 25 Dec 2010 02:07:13 +0000
Subject: Document require_relative

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@30342 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 load.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'load.c')

diff --git a/load.c b/load.c
index 7f23183c1f..2628b31c12 100644
--- a/load.c
+++ b/load.c
@@ -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);
-- 
cgit v1.2.3