From 1fd840a063c554977eb948f9c13f928524e7c425 Mon Sep 17 00:00:00 2001 From: zzak Date: Sun, 27 Jul 2014 20:23:45 +0000 Subject: * 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 --- ChangeLog | 6 ++++++ file.c | 10 ++++++---- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/ChangeLog b/ChangeLog index e3ac32ccc2..0334fe5fcd 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +Mon Jul 28 05:21:41 2014 Zachary Scott + + * 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] + Mon Jul 28 05:12:22 2014 Zachary Scott * time.c: [DOC] Remove dead link and old bug report, which hasn't been diff --git a/file.c b/file.c index bd6ced5c20..4fc5f771cf 100644 --- a/file.c +++ b/file.c @@ -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 true 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 -- cgit v1.2.3