1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

* complex.c: Examples for Complex Documentation.

Patch by Robin Dupret.
  Fixes #184 on github.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@36993 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
zzak 2012-09-19 22:23:15 +00:00
parent cca61dafe8
commit 7c4d0468df
2 changed files with 23 additions and 3 deletions

View file

@ -1,3 +1,9 @@
Thu Sep 20 07:20:00 2012 Zachary Scott <zzak@ruby-lang.org>
* complex.c: Examples for Complex Documentation.
Patch by Robin Dupret.
Fixes #184 on github.
Thu Sep 20 07:15:00 2012 Zachary Scott <zzak@ruby-lang.org>
* ext/ripper/lib/ripper.rb: Documentation for Ripper.

View file

@ -440,6 +440,10 @@ nucomp_s_canonicalize_internal(VALUE klass, VALUE real, VALUE imag)
* Complex.rectangular(real[, imag]) -> complex
*
* Returns a complex object which denotes the given rectangular form.
*
* For example:
* Complex.rect(12, 2) # => (12+2i)
* Complex.rect(0, 17) # => (0+17i)
*/
static VALUE
nucomp_s_new(int argc, VALUE *argv, VALUE klass)
@ -679,7 +683,11 @@ f_addsub(VALUE self, VALUE other,
* call-seq:
* cmp + numeric -> complex
*
* Performs addition.
* Performs addition on the first member of the Complex.
*
* Complex(5, 2) + 3 # => (8+2i)
* Complex(11, 3) + 4 # => (15+3i)
*
*/
static VALUE
nucomp_add(VALUE self, VALUE other)
@ -691,7 +699,10 @@ nucomp_add(VALUE self, VALUE other)
* call-seq:
* cmp - numeric -> complex
*
* Performs subtraction.
* Performs subtraction on the first member of the Complex.
*
* Complex(33, 12) - 10 # => (23+12i)
* Complex(12.4, 3.5) - 5 # => (7.4+3.5i)
*/
static VALUE
nucomp_sub(VALUE self, VALUE other)
@ -703,7 +714,10 @@ nucomp_sub(VALUE self, VALUE other)
* call-seq:
* cmp * numeric -> complex
*
* Performs multiplication.
* Performs multiplication on the two members.
*
* Complex(78, 58) * 10 # => (780+580i)
* Complex(5.6, 3.4) * 10 # => (56+34i)
*/
static VALUE
nucomp_mul(VALUE self, VALUE other)