* array.c, enum.c, eval.c, file.c, io.c, numeric.c, object.c, prec.c,

nobu · nobu · commit da011c831108 · 2004-04-14T04:06:52.000Z
process.c, re.c, string.c: typos in RDoc comments.  [ruby-core:02783]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@6158 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
diff --git a/ChangeLog b/ChangeLog
@@ -1,10 +1,15 @@
+Wed Apr 14 13:06:35 2004  Doug Kearns  <djkea2@mugca.its.monash.edu.au>
+
+	* array.c, enum.c, eval.c, file.c, io.c, numeric.c, object.c, prec.c,
+	  process.c, re.c, string.c: typos in RDoc comments.  [ruby-core:02783]
+
 Wed Apr 14 11:03:22  Hirokazu Yamamoto  <ocean@m2.ccsnet.ne.jp>
 
 	* defines.h: include <net/socket.h> to get fd_set definition in BeOS.
 
 Tue Apr 13 23:06:30 2004  Masatoshi SEKI  <m_seki@mva.biglobe.ne.jp>
 
-	* lib/rinda/rinda.rb: change pattern matching. 
+	* lib/rinda/rinda.rb: change pattern matching.
 	  a === b -> a == b || a === b. [druby-ja:98]
 
 	* test/rinda/test_rinda.rb: ditto.
diff --git a/array.c b/array.c
@@ -2001,7 +2001,7 @@ rb_ary_delete_if(ary)
  *  <i>self</i> with corresponding elements from each argument. This
  *  generates a sequence of <code>self#size</code> <em>n</em>-element
  *  arrays, where <em>n</em> is one more that the count of arguments. If
- *  the size of any arguemnt is less than <code>enumObj#size</code>,
+ *  the size of any argument is less than <code>enumObj#size</code>,
  *  <code>nil</code> values are supplied. If a block given, it is
  *  invoked for each output array, otherwise an array of arrays is
  *  returned.
@@ -2343,7 +2343,7 @@ rb_ary_times(ary, times)
  *   comparing _obj_ with the first element of each contained array
  *   using obj.==.
  *   Returns the first contained array that matches (that
- *   is, the first assoc}iated array,
+ *   is, the first associated array),
  *   or +nil+ if no match is found.
  *   See also Array.rassoc.
  *
diff --git a/enum.c b/enum.c
@@ -864,7 +864,7 @@ zip_i(val, memo)
  *  <i>enum</i> with corresponding elements from each argument. This
  *  generates a sequence of <code>enum#size</code> <em>n</em>-element
  *  arrays, where <em>n</em> is one more that the count of arguments. If
- *  the size of any arguemnt is less than <code>enum#size</code>,
+ *  the size of any argument is less than <code>enum#size</code>,
  *  <code>nil</code> values are supplied. If a block given, it is
  *  invoked for each output array, otherwise an array of arrays is
  *  returned.
diff --git a/eval.c b/eval.c
@@ -5257,7 +5257,7 @@ static int last_call_status;
  *  Invoked by Ruby when <i>obj</i> is sent a message it cannot handle.
  *  <i>symbol</i> is the symbol for the method called, and <i>args</i>
  *  are any arguments that were passed to it. By default, the interpreter
- *  raises an error when this method is called. However, it is possibe
+ *  raises an error when this method is called. However, it is possible
  *  to override the method to provide more dynamic behavior.
  *  The example below creates
  *  a class <code>Roman</code>, which responds to methods with names
diff --git a/file.c b/file.c
@@ -481,7 +481,7 @@ rb_stat_ctime(self)
  * call-seq:
  *   stat.inspect  =>  string
  *
- * Produce a nicely formatted descriptin of <i>stat</i>.
+ * Produce a nicely formatted description of <i>stat</i>.
  *
  *   File.stat("/etc/passwd").inspect
  *      #=> "#<File::Stat dev=0xe000005, ino=1078078, mode=0100644, 
diff --git a/io.c b/io.c
@@ -1317,7 +1317,7 @@ rb_io_gets(io)
  *  <i>sep_string</i>. A separator of <code>nil</code> reads the entire
  *  contents, and a zero-length separator reads the input a paragraph at
  *  a time (two successive newlines in the input separate paragraphs).
- *  The stream must be opened for reading or an <code>IOerror</code>
+ *  The stream must be opened for reading or an <code>IOError</code>
  *  will be raised. The line read in will be returned and also assigned
  *  to <code>$_</code>. Returns <code>nil</code> if called at end of
  *  file.
@@ -1465,7 +1465,7 @@ rb_io_readline(argc, argv, io)
  *  <i>sep_string</i>. If <i>set_string</i> is <code>nil</code>, the
  *  rest of the stream is returned as a single record.
  *  The stream must be opened for reading or an
- *  <code>IOerror</code> will be raised.
+ *  <code>IOError</code> will be raised.
  *     
  *     f = File.new("testfile")
  *     f.readlines[0]   #=> "This is line one\n"
@@ -1502,7 +1502,7 @@ rb_io_readlines(argc, argv, io)
  *  
  *  Executes the block for every line in <em>ios</em>, where lines are
  *  separated by <i>sep_string</i>. <em>ios</em> must be opened for
- *  reading or an <code>IOerror</code> will be raised.
+ *  reading or an <code>IOError</code> will be raised.
  *     
  *     f = File.new("testfile")
  *     f.each {|line| puts "#{f.lineno}: #{line}" }
@@ -1544,7 +1544,7 @@ rb_io_each_line(argc, argv, io)
  *  
  *  Calls the given block once for each byte (0..255) in <em>ios</em>,
  *  passing the byte as an argument. The stream must be opened for
- *  reading or an <code>IOerror</code> will be raised.
+ *  reading or an <code>IOError</code> will be raised.
  *     
  *     f = File.new("testfile")
  *     checksum = 0
diff --git a/numeric.c b/numeric.c
@@ -682,7 +682,7 @@ flodivmod(x, y, divp, modp)
  *     flt % other         => float
  *     flt.modulo(other)   => float
  *  
- *  Return the modulo after dividion of <code>flt</code> by <code>other</code>.
+ *  Return the modulo after division of <code>flt</code> by <code>other</code>.
  *     
  *     6543.21.modulo(137)      #=> 104.21
  *     6543.21.modulo(137.24)   #=> 92.9299999999996
diff --git a/object.c b/object.c
@@ -37,7 +37,7 @@ static ID id_eq, id_eql, id_inspect, id_init_copy;
  *  call-seq:
  *     obj === other   => true or false
  *  
- *  Case Equality---For class <code>Object</code>, effectivelt the same
+ *  Case Equality---For class <code>Object</code>, effectively the same
  *  as calling  <code>#==</code>, but typically overridden by descendents
  *  to provide meaningful semantics in <code>case</code> statements.
  */
@@ -1164,7 +1164,7 @@ sym_to_s(sym)
  * call-seq:
  *   sym.to_sym   => sym
  *
- * In general, <code>to_sym</code> returns the <code>Symbol</code> correspopnding
+ * In general, <code>to_sym</code> returns the <code>Symbol</code> corresponding
  * to an object. As <i>sym</i> is already a symbol, <code>self</code> is returned
  * in this case.
  */
diff --git a/prec.c b/prec.c
@@ -123,7 +123,7 @@ prec_included(module, include)
  * Precision is a mixin for concrete numeric classes with
  * precision.  Here, `precision' means the fineness of approximation
  * of a real number, so, this module should not be included into
- * anything which is not a ubset of Real (so it should not be
+ * anything which is not a subset of Real (so it should not be
  * included in classes such as +Complex+ or +Matrix+).
 */
 
diff --git a/process.c b/process.c
@@ -1492,7 +1492,7 @@ rb_f_system(argc, argv)
  *  call-seq:
  *     sleep(duration=0)    => fixnum
  *  
- *  Suspends the current thread for _duraction_ seconds (which may be
+ *  Suspends the current thread for _duration_ seconds (which may be
  *  any number, including a +Float+ with fractional seconds). Returns the actual
  *  number of seconds slept (rounded), which may be less than that asked
  *  for if the thread was interrupted by a +SIGALRM+, or if
diff --git a/re.c b/re.c
@@ -410,7 +410,7 @@ rb_reg_inspect(re)
  *  call-seq:
  *     rxp.to_s   => str
  *  
- *  Returns a string containing the regular expression and its options (usng the
+ *  Returns a string containing the regular expression and its options (using the
  *  <code>(?xxx:yyy)</code> notation. This string can be fed back in to
  *  <code>Regexp::new</code> to a regular expression with the same semantics as
  *  the original. (However, <code>Regexp#==</code> may not return true when
@@ -1124,7 +1124,7 @@ match_array(match, start)
  *     m = /(.)(.)(\d+)(\d)/.match("THX1138.")
  *     m.to_a   #=> ["HX1138", "H", "X", "113", "8"]
  *     
- *  Because <code>to_a</code> is called when exanding
+ *  Because <code>to_a</code> is called when expanding
  *  <code>*</code><em>variable</em>, there's a useful assignment
  *  shortcut for extracting matched fields. This is slightly slower than
  *  accessing the fields directly (as an intermediate array is
diff --git a/string.c b/string.c
@@ -3396,11 +3396,11 @@ rb_str_count(argc, argv, str)
  *  split on whitespace as if ` ' were specified.
  *     
  *  If the <i>limit</i> parameter is omitted, trailing null fields are
- *  supressed. If <i>limit</i> is a positive number, at most that number of
+ *  suppressed. If <i>limit</i> is a positive number, at most that number of
  *  fields will be returned (if <i>limit</i> is <code>1</code>, the entire
  *  string is returned as the only entry in an array). If negative, there is no
  *  limit to the number of fields returned, and trailing null fields are not
- *  supressed.
+ *  suppressed.
  *     
  *     " now's  the time".split        #=> ["now's", "the", "time"]
  *     " now's  the time".split(' ')   #=> ["now's", "the", "time"]

Original file line number	Diff line number	Diff line change
`@@ -481,7 +481,7 @@ rb_stat_ctime(self)`
`481`	`481`	`* call-seq:`
`482`	`482`	`* stat.inspect => string`
`483`	`483`	`*`
`484`		`- * Produce a nicely formatted descriptin of <i>stat</i>.`
	`484`	`+ * Produce a nicely formatted description of <i>stat</i>.`
`485`	`485`	`*`
`486`	`486`	`* File.stat("/etc/passwd").inspect`
`487`	`487`	`* #=> "#<File::Stat dev=0xe000005, ino=1078078, mode=0100644,`
Original file line number	Diff line number	Diff line change
`@@ -682,7 +682,7 @@ flodivmod(x, y, divp, modp)`
`682`	`682`	`* flt % other => float`
`683`	`683`	`* flt.modulo(other) => float`
`684`	`684`	`*`
`685`		`- * Return the modulo after dividion of <code>flt</code> by <code>other</code>.`
	`685`	`+ * Return the modulo after division of <code>flt</code> by <code>other</code>.`
`686`	`686`	`*`
`687`	`687`	`* 6543.21.modulo(137) #=> 104.21`
`688`	`688`	`* 6543.21.modulo(137.24) #=> 92.9299999999996`
Original file line number	Diff line number	Diff line change
`@@ -1492,7 +1492,7 @@ rb_f_system(argc, argv)`
`1492`	`1492`	`* call-seq:`
`1493`	`1493`	`* sleep(duration=0) => fixnum`
`1494`	`1494`	`*`
`1495`		`- * Suspends the current thread for _duraction_ seconds (which may be`
	`1495`	`+ * Suspends the current thread for _duration_ seconds (which may be`
`1496`	`1496`	`* any number, including a +Float+ with fractional seconds). Returns the actual`
`1497`	`1497`	`* number of seconds slept (rounded), which may be less than that asked`
`1498`	`1498`	`* for if the thread was interrupted by a +SIGALRM+, or if`