Skip to content

Commit c3d92d3

Browse files
[DOC] More on paths and lists (#86)
* More on paths and lists
1 parent 5f9ef9d commit c3d92d3

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

lib/fileutils.rb

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ def mkdir(list, mode: nil, noop: nil, verbose: nil)
336336

337337
#
338338
# Creates directories at the paths in the given +list+
339-
# (an array of strings or a single string),
339+
# (a single path or an array of paths),
340340
# also creating ancestor directories as needed;
341341
# returns +list+ if it is an array, <tt>[list]</tt> otherwise.
342342
#
@@ -412,7 +412,7 @@ def fu_mkdir(path, mode) #:nodoc:
412412

413413
#
414414
# Removes directories at the paths in the given +list+
415-
# (an array of strings or a single string);
415+
# (a single path or an array of paths);
416416
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
417417
#
418418
# Argument +list+ or its elements
@@ -464,7 +464,8 @@ def rmdir(list, parents: nil, noop: nil, verbose: nil)
464464

465465
# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link].
466466
#
467-
# Arguments +src+ and +dest+
467+
# Arguments +src+ (a single path or an array of paths)
468+
# and +dest+ (a single path)
468469
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
469470
#
470471
# When +src+ is the path to an existing file
@@ -531,7 +532,8 @@ def ln(src, dest, force: nil, noop: nil, verbose: nil)
531532

532533
# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link].
533534
#
534-
# Arguments +src+ and +dest+
535+
# Arguments +src+ (a single path or an array of paths)
536+
# and +dest+ (a single path)
535537
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
536538
#
537539
# If +src+ is the path to a directory and +dest+ does not exist,
@@ -615,7 +617,8 @@ def cp_lr(src, dest, noop: nil, verbose: nil,
615617

616618
# Creates {symbolic links}[https://en.wikipedia.org/wiki/Symbolic_link].
617619
#
618-
# Arguments +src+ and +dest+
620+
# Arguments +src+ (a single path or an array of paths)
621+
# and +dest+ (a single path)
619622
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
620623
#
621624
# When +src+ is the path to an existing file:
@@ -750,7 +753,8 @@ def link_entry(src, dest, dereference_root = false, remove_destination = false)
750753

751754
# Copies files from +src+ to +dest+.
752755
#
753-
# Arguments +src+ and +dest+
756+
# Arguments +src+ (a single path or an array of paths)
757+
# and +dest+ (a single path)
754758
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
755759
#
756760
# If +src+ is the path to a file and +dest+ is not the path to a directory,
@@ -991,7 +995,8 @@ def copy_stream(src, dest)
991995
end
992996
module_function :copy_stream
993997

994-
# Moves files from +src+ to +dest+.
998+
# Moves files from +src+ (a single path or an array of paths)
999+
# to +dest+ (a single path).
9951000
# If +src+ and +dest+ are on different devices,
9961001
# first copies, then removes +src+.
9971002
#
@@ -1087,7 +1092,8 @@ def mv(src, dest, force: nil, noop: nil, verbose: nil, secure: nil)
10871092
alias move mv
10881093
module_function :move
10891094

1090-
# Removes entries at the paths in the given +list+;
1095+
# Removes entries at the paths in the given +list+
1096+
# (a single path or an array of paths)
10911097
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
10921098
#
10931099
# Argument +list+ or its elements
@@ -1147,7 +1153,7 @@ def rm_f(list, noop: nil, verbose: nil)
11471153
module_function :safe_unlink
11481154

11491155
# Removes entries at the paths in the given +list+
1150-
# (an array of strings or a single string);
1156+
# (a single path or an array of paths);
11511157
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
11521158
#
11531159
# Argument +list+ or its elements
@@ -1596,6 +1602,7 @@ def mode_to_s(mode) #:nodoc:
15961602
private_module_function :mode_to_s
15971603

15981604
# Changes permissions on the entries at the paths given in +list+
1605+
# (a single path or an array of paths)
15991606
# to the permissions given by +mode+:
16001607
#
16011608
# - Modifies each entry that is a regular file using
@@ -1694,6 +1701,7 @@ def chmod_R(mode, list, noop: nil, verbose: nil, force: nil)
16941701
module_function :chmod_R
16951702

16961703
# Changes the owner and group on the entries at the paths given in +list+
1704+
# (a single path or an array of paths)
16971705
# to the given +user+ and +group+:
16981706
#
16991707
# - Modifies each entry that is a regular file using
@@ -1818,7 +1826,8 @@ def fu_get_gid(group) #:nodoc:
18181826
private_module_function :fu_get_gid
18191827

18201828
# Updates modification times (mtime) and access times (atime)
1821-
# of the entries given by the paths in +list+;
1829+
# of the entries given by the paths in +list+
1830+
# (a single path or an array of paths);
18221831
# by default, creates an empty file for any path to a non-existent entry.
18231832
#
18241833
# Argument +list+ or its elements

0 commit comments

Comments
 (0)