Skip to content

Commit c25f069

Browse files
committed
[DOC] Fix optional argument descriptions
Several optional positional arguments were incorrectly denoted as keyword arguments so correct them.
1 parent 48742e2 commit c25f069

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

lib/fileutils.rb

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -800,13 +800,13 @@ def ln_sr(src, dest, target_directory: true, force: nil, noop: nil, verbose: nil
800800
# File.file?('dest1/dir1/t2.txt') # => true
801801
# File.file?('dest1/dir1/t3.txt') # => true
802802
#
803-
# Keyword arguments:
803+
# Optional arguments:
804804
#
805-
# - <tt>dereference_root: true</tt> - dereferences +src+ if it is a symbolic link.
806-
# - <tt>remove_destination: true</tt> - removes +dest+ before creating links.
805+
# - +dereference_root+ - dereferences +src+ if it is a symbolic link (+false+ by default).
806+
# - +remove_destination+ - removes +dest+ before creating links (+false+ by default).
807807
#
808808
# Raises an exception if +dest+ is the path to an existing file or directory
809-
# and keyword argument <tt>remove_destination: true</tt> is not given.
809+
# and optional argument +remove_destination+ is not given.
810810
#
811811
# Related: FileUtils.ln (has different options).
812812
#
@@ -1029,12 +1029,12 @@ def cp_r(src, dest, preserve: nil, noop: nil, verbose: nil,
10291029
# directories, and symbolic links;
10301030
# other file types (FIFO streams, device files, etc.) are not supported.
10311031
#
1032-
# Keyword arguments:
1032+
# Optional arguments:
10331033
#
1034-
# - <tt>dereference_root: true</tt> - if +src+ is a symbolic link,
1035-
# follows the link.
1036-
# - <tt>preserve: true</tt> - preserves file times.
1037-
# - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
1034+
# - +dereference_root+ - if +src+ is a symbolic link,
1035+
# follows the link (+false+ by default).
1036+
# - +preserve+ - preserves file times (+false+ by default).
1037+
# - +remove_destination+ - removes +dest+ before copying files (+false+ by default).
10381038
#
10391039
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
10401040
#
@@ -1065,12 +1065,12 @@ def copy_entry(src, dest, preserve = false, dereference_root = false, remove_des
10651065
# FileUtils.copy_file('src0.txt', 'dest0.txt')
10661066
# File.file?('dest0.txt') # => true
10671067
#
1068-
# Keyword arguments:
1068+
# Optional arguments:
10691069
#
1070-
# - <tt>dereference: false</tt> - if +src+ is a symbolic link,
1071-
# does not follow the link.
1072-
# - <tt>preserve: true</tt> - preserves file times.
1073-
# - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
1070+
# - +dereference+ - if +src+ is a symbolic link,
1071+
# follows the link (+true+ by default).
1072+
# - +preserve+ - preserves file times (+false+ by default).
1073+
# - +remove_destination+ - removes +dest+ before copying files (+false+ by default).
10741074
#
10751075
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
10761076
#

0 commit comments

Comments
 (0)