diff options
author | Benoit Daloze <eregontp@gmail.com> | 2022-06-21 18:40:28 +0200 |
---|---|---|
committer | Benoit Daloze <eregontp@gmail.com> | 2022-06-21 18:40:28 +0200 |
commit | 1f067e775d8629ac3b33f96dd885d5f996e787f3 (patch) | |
tree | a5365ab9bba25456856c5a789cc46f8a9fceef79 /load.c | |
parent | 2e81fd764b9046389f432181b5b3a3192621bde7 (diff) | |
download | ruby-1f067e775d8629ac3b33f96dd885d5f996e787f3.tar.gz |
Clarify documentation of Kernel#require_relative
Diffstat (limited to 'load.c')
-rw-r--r-- | load.c | 7 |
1 files changed, 4 insertions, 3 deletions
@@ -945,9 +945,10 @@ rb_f_require(VALUE obj, VALUE fname) * 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. + * Ruby tries to load the library named _string_ relative to the directory + * containing the requiring file. If the file does not exist a LoadError is + * raised. Returns +true+ if the file was loaded and +false+ if the file was + * already loaded before. */ VALUE rb_f_require_relative(VALUE obj, VALUE fname) |