summaryrefslogtreecommitdiff
path: root/lib/fileutils.rb
diff options
context:
space:
mode:
authorBurdetteLamar <[email protected]>2022-05-11 08:48:19 -0700
committergit <[email protected]>2022-05-12 04:11:50 +0900
commitdbca60c58d3bd34a855b10a40e8f086296efe426 ()
treea01f5957673dacc768d6eb5fea874dc3b92f8714 /lib/fileutils.rb
parent4da0f7a7f565c252f7a031472b796410ab8d5ac1 (diff)
[ruby/fileutils] Enhanced RDoc for FileUtils
https://.com/ruby/fileutils/commit/a0ea474214
-rw-r--r--lib/fileutils.rb66
1 files changed, 52 insertions, 14 deletions
@@ -236,19 +236,35 @@ module FileUtils
module_function :mkdir
#
- # Creates a directory and all its parent directories.
- # For example,
#
- # FileUtils.mkdir_p '/usr/local/lib/ruby'
#
- # causes to make following directories, if they do not exist.
#
- # * /usr
- # * /usr/local
- # * /usr/local/lib
- # * /usr/local/lib/ruby
#
- # You can pass several directories at a time in a list.
#
def mkdir_p(list, mode: nil, noop: nil, verbose: nil)
list = fu_list(list)
@@ -293,12 +309,34 @@ module FileUtils
private_module_function :fu_mkdir
#
- # Removes one or more directories.
#
- # FileUtils.rmdir 'somedir'
- # FileUtils.rmdir %w(somedir anydir otherdir)
- # # Does not really remove directory; outputs message.
- # FileUtils.rmdir 'somedir', verbose: true, noop: true
#
def rmdir(list, parents: nil, noop: nil, verbose: nil)
list = fu_list(list)