diff options
author | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2014-07-27 20:23:45 +0000 |
---|---|---|
committer | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2014-07-27 20:23:45 +0000 |
commit | 1fd840a063c554977eb948f9c13f928524e7c425 (patch) | |
tree | 5a416db78e21972e91155bfd0a633d5789e784bc /file.c | |
parent | 0eed69757dd2bc0eb460a5dc38e377ac8e2cbfd9 (diff) | |
download | ruby-1fd840a063c554977eb948f9c13f928524e7c425.tar.gz |
* file.c: [DOC] Clarify how File.file? handles symbolic links. Also
cleaned up the rdoc style for this method, more to follow.
Originally reported by Michael Renner [Bug #10067]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@46978 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'file.c')
-rw-r--r-- | file.c | 10 |
1 files changed, 6 insertions, 4 deletions
@@ -1645,12 +1645,14 @@ rb_file_executable_real_p(VALUE obj, VALUE fname) /* * call-seq: - * File.file?(file_name) -> true or false + * File.file?(file) -> true or false * - * Returns <code>true</code> if the named file exists and is a - * regular file. + * Returns +true+ if the named +file+ exists and is a regular file. * - * _file_name_ can be an IO object. + * +file+ can be an IO object. + * + * If the +file+ argument is a symbolic link, it will resolve the symbolic link + * and use the file referenced by the link. */ static VALUE |