RDoc for Complex

BurdetteLamar · peterzhu2118 · commit 8ad8803bb4ae · 2023-12-24T11:00:30.000-05:00
diff --git a/complex.c b/complex.c
@@ -789,8 +789,6 @@ rb_complex_real(VALUE self)
  *
  *   Complex.polar(1, Math::PI/4).imag # => 0.7071067811865476 # Square root of 2.
  *
- * \Complex#imaginary is an alias for \Complex#imag.
- *
  */
 VALUE
 rb_complex_imag(VALUE self)
@@ -1001,7 +999,6 @@ f_divide(VALUE self, VALUE other,
  *   Complex(9, 8)  / 4              # => ((9/4)+(2/1)*i)
  *   Complex(20, 9) / 9.8            # => (2.0408163265306123+0.9183673469387754i)
  *
- * Complex#quo is an alias for Complex#/.
  */
 VALUE
 rb_complex_div(VALUE self, VALUE other)
@@ -1327,7 +1324,6 @@ nucomp_coerce(VALUE self, VALUE other)
  *
  *   Complex.rectangular(1, 1).abs # => 1.4142135623730951 # The square root of 2.
  *
- * Complex#magnitude is an alias for Complex#abs.
  */
 VALUE
 rb_complex_abs(VALUE self)
@@ -1388,7 +1384,6 @@ nucomp_abs2(VALUE self)
  *
  *   Complex.polar(1, 1.0/3).arg # => 0.33333333333333326
  *
- * Complex#angle and Complex#phase are aliases for Complex#arg.
  */
 VALUE
 rb_complex_arg(VALUE self)
@@ -1454,7 +1449,6 @@ nucomp_polar(VALUE self)
  *
  *   Complex.rect(1, 2).conj # => (1-2i)
  *
- * Complex#conjugate is an alias for Complex#conj.
  */
 VALUE
 rb_complex_conjugate(VALUE self)
@@ -1547,6 +1541,18 @@ rb_complex_hash(VALUE self)
     return v;
 }
 
+/*
+ * :call-seq:
+ *   hash -> integer
+ *
+ * Returns the integer hash value for +self+.
+ *
+ * Two \Complex objects created from the same values will have the same hash value
+ * (and will compare using #eql?):
+ *
+ *   Complex(1, 2).hash == Complex(1, 2).hash # => true
+ *
+ */
 static VALUE
 nucomp_hash(VALUE self)
 {

Original file line number	Diff line number	Diff line change
`@@ -789,8 +789,6 @@ rb_complex_real(VALUE self)`
`789`	`789`	`*`
`790`	`790`	`* Complex.polar(1, Math::PI/4).imag # => 0.7071067811865476 # Square root of 2.`
`791`	`791`	`*`
`792`		`- * \Complex#imaginary is an alias for \Complex#imag.`
`793`		`- *`
`794`	`792`	`*/`
`795`	`793`	`VALUE`
`796`	`794`	`rb_complex_imag(VALUE self)`
`@@ -1001,7 +999,6 @@ f_divide(VALUE self, VALUE other,`
`1001`	`999`	`* Complex(9, 8) / 4 # => ((9/4)+(2/1)*i)`
`1002`	`1000`	`* Complex(20, 9) / 9.8 # => (2.0408163265306123+0.9183673469387754i)`
`1003`	`1001`	`*`
`1004`		`- * Complex#quo is an alias for Complex#/.`
`1005`	`1002`	`*/`
`1006`	`1003`	`VALUE`
`1007`	`1004`	`rb_complex_div(VALUE self, VALUE other)`
`@@ -1327,7 +1324,6 @@ nucomp_coerce(VALUE self, VALUE other)`
`1327`	`1324`	`*`
`1328`	`1325`	`* Complex.rectangular(1, 1).abs # => 1.4142135623730951 # The square root of 2.`
`1329`	`1326`	`*`
`1330`		`- * Complex#magnitude is an alias for Complex#abs.`
`1331`	`1327`	`*/`
`1332`	`1328`	`VALUE`
`1333`	`1329`	`rb_complex_abs(VALUE self)`
`@@ -1388,7 +1384,6 @@ nucomp_abs2(VALUE self)`
`1388`	`1384`	`*`
`1389`	`1385`	`* Complex.polar(1, 1.0/3).arg # => 0.33333333333333326`
`1390`	`1386`	`*`
`1391`		`- * Complex#angle and Complex#phase are aliases for Complex#arg.`
`1392`	`1387`	`*/`
`1393`	`1388`	`VALUE`
`1394`	`1389`	`rb_complex_arg(VALUE self)`
`@@ -1454,7 +1449,6 @@ nucomp_polar(VALUE self)`
`1454`	`1449`	`*`
`1455`	`1450`	`* Complex.rect(1, 2).conj # => (1-2i)`
`1456`	`1451`	`*`
`1457`		`- * Complex#conjugate is an alias for Complex#conj.`
`1458`	`1452`	`*/`
`1459`	`1453`	`VALUE`
`1460`	`1454`	`rb_complex_conjugate(VALUE self)`
`@@ -1547,6 +1541,18 @@ rb_complex_hash(VALUE self)`
`1547`	`1541`	`return v;`
`1548`	`1542`	`}`
`1549`	`1543`
	`1544`	`+/*`
	`1545`	`+ * :call-seq:`
	`1546`	`+ * hash -> integer`
	`1547`	`+ *`
	`1548`	`+ * Returns the integer hash value for +self+.`
	`1549`	`+ *`
	`1550`	`+ * Two \Complex objects created from the same values will have the same hash value`
	`1551`	`+ * (and will compare using #eql?):`
	`1552`	`+ *`
	`1553`	`+ * Complex(1, 2).hash == Complex(1, 2).hash # => true`
	`1554`	`+ *`
	`1555`	`+ */`
`1550`	`1556`	`static VALUE`
`1551`	`1557`	`nucomp_hash(VALUE self)`
`1552`	`1558`	`{`