diff options
| author | stomar <stomar@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2017-03-01 08:54:37 +0000 |
|---|---|---|
| committer | stomar <stomar@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2017-03-01 08:54:37 +0000 |
| commit | 7957042253036d9aec3833b048ab00ad9ac5364d (patch) | |
| tree | ffd6a3ea53139d01dbd43bd35c1e35ca63d8527b /lib/fileutils.rb | |
| parent | 3cef10489ae2e61ef0a14d9b676d0242e4640ccd (diff) | |
fileutils.rb: improve docs for FileUtils.compare_file
* lib/fileutils.rb (compare_file): [DOC] clarify documentation
by avoiding confusing return value of "maybe false".
[ruby-core:75431] [Misc #12365] reported by Robert A. Heiler.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57749 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/fileutils.rb')
| -rw-r--r-- | lib/fileutils.rb | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/fileutils.rb b/lib/fileutils.rb index b24d6f4dcb..e641528b3a 100644 --- a/lib/fileutils.rb +++ b/lib/fileutils.rb @@ -711,10 +711,10 @@ module FileUtils module_function :remove_dir # - # Returns true if the contents of a file A and a file B are identical. + # Returns true if the contents of a file +a+ and a file +b+ are identical. # - # FileUtils.compare_file('somefile', 'somefile') #=> true - # FileUtils.compare_file('/bin/cp', '/bin/mv') #=> maybe false + # FileUtils.compare_file('somefile', 'somefile') #=> true + # FileUtils.compare_file('/dev/null', '/dev/urandom') #=> false # def compare_file(a, b) return false unless File.size(a) == File.size(b) |