From 5b91ab1f2e55bbd2965e702830404fadd90043cd Mon Sep 17 00:00:00 2001 From: eregon Date: Tue, 22 Oct 2013 07:59:23 +0000 Subject: * 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 --- file.c | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'file.c') diff --git a/file.c b/file.c index acbaa5c5f4..a29de3b1ab 100644 --- a/file.c +++ b/file.c @@ -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 dir_string 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 -- cgit v1.2.3