diff options
author | eregon <eregon@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-10-22 07:59:23 +0000 |
---|---|---|
committer | eregon <eregon@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-10-22 07:59:23 +0000 |
commit | 5b91ab1f2e55bbd2965e702830404fadd90043cd (patch) | |
tree | da74914ef822956394d6009ddcf50d5fb197392d /file.c | |
parent | f57c988e343a4d682d3a988127b0552dde3caf3e (diff) | |
download | ruby-5b91ab1f2e55bbd2965e702830404fadd90043cd.tar.gz |
* file.c (File#expand_path): [DOC] improve documentation of File#expand_path.
Based on patch by Prathamesh Sonpatki. [ruby-core:57734] [Bug #9002]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@43386 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'file.c')
-rw-r--r-- | file.c | 13 |
1 files changed, 12 insertions, 1 deletions
@@ -3432,7 +3432,18 @@ rb_file_expand_path_fast(VALUE fname, VALUE dname) * user's home directory. * * File.expand_path("~oracle/bin") #=> "/home/oracle/bin" - * File.expand_path("../../bin", "/tmp/x") #=> "/bin" + * + * A simple example of using <i>dir_string</i> is as follows. + * File.expand_path("ruby", "/usr/bin") #=> "/usr/bin/ruby" + * + * A more complex example which also resolves parent directory is as follows. + * Suppose we are in bin/mygem and want the absolute path of lib/mygem.rb. + * + * File.expand_path("../../lib/mygem.rb", __FILE__) + * #=> ".../path/to/project/lib/mygem.rb" + * + * So first it resolves the parent of __FILE__, that is bin/, then go to the + * parent, the root of the project and appends +lib/mygem.rb+. */ VALUE |