diff options
author | marcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2010-05-13 05:49:55 +0000 |
---|---|---|
committer | marcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2010-05-13 05:49:55 +0000 |
commit | 4afa9ed0418555ba20158e55cf3bf9ec563fbecb (patch) | |
tree | 1dec7ee61e0d81c64aa0d32a5b7a7c0e8481282a /dir.c | |
parent | 8092a810ff9a433e3f7d4edefc7744dfa81d8c70 (diff) | |
download | ruby-4afa9ed0418555ba20158e55cf3bf9ec563fbecb.tar.gz |
* array.c: Harmonize documentation, in particular regarding:
- methods returning enumerators
- array methods and argument naming (array -> ary, an_array -> new_ary)
- minor improvements, typo fixed and styling issues
Other documentation errors fixed:
- return value was self instead of a new array (or vice-versa) for
Array#{pop,shift,permutation,repeated_permutation,keep_if}
- Array#rindex was missing the form with a block.
* dir.c: ditto.
* enum.c: ditto. Modified Enumerable#reverse_each' documentation to clarify
that #each will be finish before any element is yielded.
* error.c: ditto.
* gc.c: ditto.
* hash.c: ditto.
* io.c: ditto. IO#{codepoints,each_codepoint} fixed as per [ruby-core:23948]
* numeric.c: ditto.
* range.c: ditto.
* string.c: ditto.
* struct.c: ditto.
* vm_eval.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27777 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'dir.c')
-rw-r--r-- | dir.c | 6 |
1 files changed, 6 insertions, 0 deletions
@@ -592,10 +592,13 @@ dir_read(VALUE dir) /* * call-seq: * dir.each { |filename| block } => dir + * dir.each => an_enumerator * * Calls the block once for each entry in this directory, passing the * filename of each entry as a parameter to the block. * + * If no block is given, an enumerator is returned instead. + * * d = Dir.new("testdir") * d.each {|x| puts "Got #{x}" } * @@ -1820,10 +1823,13 @@ dir_open_dir(int argc, VALUE *argv) /* * call-seq: * Dir.foreach( dirname ) {| filename | block } => nil + * Dir.foreach( dirname ) => an_enumerator * * Calls the block once for each entry in the named directory, passing * the filename of each entry as a parameter to the block. * + * If no block is given, an enumerator is returned instead. + * * Dir.foreach("testdir") {|x| puts "Got #{x}" } * * <em>produces:</em> |