1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

dir.c: document base keyword argument of Dir.glob

Browse Source 
* dir.c: [DOC] document the new `base` keyword argument of Dir.glob
  [Feature #13056]; also improve docs for Dir.glob and Dir[].

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58885 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
stomar 2017-05-25 08:34:13 +00:00
parent 135c7a53ec
commit 4bc4403b2d
1 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
dir.c
View File

@ -2463,10 +2463,10 @@ dir_glob_options(VALUE opt, VALUE *base, int *flags)
/* /*
* call-seq: * call-seq:
* Dir[ string [, string ...], [base: path] ] -> array * Dir[ string [, string ...] [, base: path] ] -> array
* *
* Equivalent to calling * Equivalent to calling
* <code>Dir.glob([</code><i>string,...</i><code>],0)</code>. * <code>Dir.glob([</code><i>string,...</i><code>], 0)</code>.
* *
*/ */
static VALUE static VALUE
@ -2483,16 +2483,21 @@ dir_s_aref(int argc, VALUE *argv, VALUE obj)
/* /*
* call-seq: * call-seq:
* Dir.glob( pattern, [flags], [base: path] ) -> matches * Dir.glob( pattern, [flags], [base: path] ) -> array
* Dir.glob( pattern, [flags], [base: path] ) { |filename| block } -> nil * Dir.glob( pattern, [flags], [base: path] ) { |filename| block } -> nil
* *
* Expands +pattern+, which is an Array of patterns or a pattern String, and * Expands +pattern+, which is a pattern string or an Array of pattern
* returns the results as +matches+ or as arguments given to the block. * strings, and returns an array containing the matching filenames.
* If a block is given, calls the block once for each matching filename,
* passing the filename as a parameter to the block.
* *
* Note that this pattern is not a regexp, it's closer to a shell glob. See * The optional +base+ keyword argument specifies the base directory for
* File::fnmatch for the meaning of the +flags+ parameter. Note that case * interpreting relative pathnames instead of the current working directory.
* sensitivity depends on your system (so File::FNM_CASEFOLD is ignored), as *
* does the order in which the results are returned. * Note that the pattern is not a regexp, it's closer to a shell glob.
* See File::fnmatch for the meaning of the +flags+ parameter.
* Case sensitivity depends on your system (File::FNM_CASEFOLD is ignored),
* as does the order in which the results are returned.
* *
* <code>*</code>:: * <code>*</code>::
* Matches any file. Can be restricted by other values in the glob. * Matches any file. Can be restricted by other values in the glob.
@ -2546,6 +2551,10 @@ dir_s_aref(int argc, VALUE *argv, VALUE obj)
* Dir.glob(rbfiles) #=> ["main.rb", * Dir.glob(rbfiles) #=> ["main.rb",
* # "lib/song.rb", * # "lib/song.rb",
* # "lib/song/karaoke.rb"] * # "lib/song/karaoke.rb"]
*
* Dir.glob(rbfiles, base: "lib") #=> ["lib/song.rb",
* # "lib/song/karaoke.rb"]
*
* libdirs = File.join("**", "lib") * libdirs = File.join("**", "lib")
* Dir.glob(libdirs) #=> ["lib"] * Dir.glob(libdirs) #=> ["lib"]
* *