archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-08-15 13:39:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[ruby/fileutils] [DOC] Fix optional argument descriptions

Browse source 
Several optional positional arguments were incorrectly denoted as
keyword arguments so correct them.

c25f069f96
This commit is contained in:
Akihiko Odaki 2024-02-23 21:34:44 +09:00 • committed by git
parent cfe8263f41
commit eeb682c51b
1 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

28
lib/fileutils.rb
View file

@ -792,13 +792,13 @@ module FileUtils
# File.file?('dest1/dir1/t2.txt') # => true
# File.file?('dest1/dir1/t3.txt') # => true
#
# Keyword arguments:
# Optional arguments:
#
# - <tt>dereference_root: true</tt> - dereferences +src+ if it is a symbolic link.
# - <tt>remove_destination: true</tt> - removes +dest+ before creating links.
# - +dereference_root+ - dereferences +src+ if it is a symbolic link (+false+ by default).
# - +remove_destination+ - removes +dest+ before creating links (+false+ by default).
#
# Raises an exception if +dest+ is the path to an existing file or directory
# and keyword argument <tt>remove_destination: true</tt> is not given.
# and optional argument +remove_destination+ is not given.
#
# Related: FileUtils.ln (has different options).
#
@ -1021,12 +1021,12 @@ module FileUtils
# directories, and symbolic links;
# other file types (FIFO streams, device files, etc.) are not supported.
#
# Keyword arguments:
# Optional arguments:
#
# - <tt>dereference_root: true</tt> - if +src+ is a symbolic link,
# follows the link.
# - <tt>preserve: true</tt> - preserves file times.
# - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
# - +dereference_root+ - if +src+ is a symbolic link,
# follows the link (+false+ by default).
# - +preserve+ - preserves file times (+false+ by default).
# - +remove_destination+ - removes +dest+ before copying files (+false+ by default).
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
@ -1057,12 +1057,12 @@ module FileUtils
# FileUtils.copy_file('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# Keyword arguments:
# Optional arguments:
#
# - <tt>dereference: false</tt> - if +src+ is a symbolic link,
# does not follow the link.
# - <tt>preserve: true</tt> - preserves file times.
# - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
# - +dereference+ - if +src+ is a symbolic link,
# follows the link (+true+ by default).
# - +preserve+ - preserves file times (+false+ by default).
# - +remove_destination+ - removes +dest+ before copying files (+false+ by default).
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#