Skip to content

[DOC] Fix optional argument descriptions #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[DOC] Fix optional argument descriptions #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions lib/fileutils.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -800,13 +800,13 @@ def ln_sr(src, dest, target_directory: true, force: nil, noop: nil, verbose: nil
# 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).
#
Expand Down Expand Up @@ -1029,12 +1029,12 @@ def cp_r(src, dest, preserve: nil, noop: nil, verbose: nil,
# 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].
#
Expand Down Expand Up @@ -1065,12 +1065,12 @@ def copy_entry(src, dest, preserve = false, dereference_root = false, remove_des
# 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].
#
Expand Down