summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBenoit Daloze <eregontp@gmail.com>2019-07-13 15:23:49 +0200
committerBenoit Daloze <eregontp@gmail.com>2019-07-13 15:23:49 +0200
commit4a935bc6f66fda448fb430c7627a2f175dcd0650 (patch)
tree29d5fbd8a3b7122286910e7383f71218e0bc090e /doc
parentb0f6f33094606e50296cb525184708454420e860 (diff)
Document $LOAD_PATH.resolve_feature_path in globals.rdoc
* RDoc does not seem to support documenting singleton object methods, and making $LOAD_PATH a class as a workaround is too weird.
Diffstat (limited to 'doc')
-rw-r--r--doc/globals.rdoc5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/globals.rdoc b/doc/globals.rdoc
index 96030ea550..284f3d764e 100644
--- a/doc/globals.rdoc
+++ b/doc/globals.rdoc
@@ -25,7 +25,10 @@ $$:: The process number of the Ruby running this script.
$?:: The status of the last executed child process. This value is
thread-local.
$LOAD_PATH:: Load path for scripts and binary modules by load or require.
- Aliased to $: and $-I.
+ Aliased to $: and $-I. Has a singleton method
+ $LOAD_PATH.resolve_feature_path(feature) that returns
+ [:rb or :so, path], which resolves the feature to the path the
+ original Kernel#require method would load.
$LOADED_FEATURES:: The array contains the module names loaded by require.
Aliased to $".
$DEBUG:: The debug flag, which is set by the -d switch. Enabling debug