8000 Update documentation for CMath library by davydovanton · Pull Request #909 · ruby/ruby · GitHub
[go: up one dir, main page]
Skip to content

Update documentation for CMath library #909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

Update documentation for CMath library #909

wants to merge 1 commit into from

Conversation

davydovanton
Copy link
Contributor

Hello,
I was created issue in redmine, but I think that here this changes will be faster to merge 😓

@gogotanaka
Copy link
Member

@davydovanton Hi! Good proposal.
The things I have to say are:

  1. We should mention complex number itslef at Complex rather than CMath.
  2. 3 + 2i(Ruby>=2.1) can also represent complex number.
  3. CMath.cos(Complex(1, 1)) is little bit better than CMath.cos(Complex(Math::PI)) for example(I can take care of it.)

thanks!

@davydovanton
Copy link
Contributor Author

@gogotanaka wow! thanks for reply! 🌟

  1. I think I can update documentation for Complex class too.
  2. wow, I don't know about this, thanks!
  3. okay, I will fix this later

@davydovanton
Copy link
Contributor Author

@gogotanaka I change example to 1 + 1i. Also I think that I need update Complex documentation in the next PR. What do you think, it's normal for you?

gogotanaka
gogotanaka reviewed Jun 5, 2015
View reviewed changes
lib/cmath.rb
# even know what they are. They would rather have Math.sqrt(-1) raise
# an exception than return a complex number.
#
# == Brief overview of complex numbers
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davydovanton Thank you for updating! How about having this section at Complex and putting link to Complex here?
sorry I just wanna avoid duplicate contents.

@davydovanton
Copy link
Contributor Author

@gogotanaka so, I did replaced Brief overview to Complex class, it's normal for you?

@DJGHOSTMACHINE
Copy link

I will let you know

@davydovanton
Copy link
Contributor Author

ok

@gogotanaka
Copy link
Member

@davydovanton Merged ⭐ thanks!
note: Since the documentation you've add to complex.c is duplication of existing one, I don't commit it for now.
But if you wanna improve it more, please feel free to open another ticket :D

@gogotanaka gogotanaka closed this in 843019f Jun 6, 2015
@davydovanton
Copy link
Contributor Author

@gogotanaka thanks for review 🌟

@davydovanton davydovanton deleted the doc-update-cmath branch June 7, 2015 13:29
@davydovanton davydovanton mentioned this pull request Jun 9, 2015
Merged
hsbt pushed a commit that referenced this pull request Jul 3, 2015
@unak
merge revision(s) 50793,51120: [Backport #11162]
a57c925 
	* lib/cmath.rb: [DOC] Add docs [ci skip][Fix GH-909][Bug #11162]
	Patch provided by @davydovanton

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_2_1@51121 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
hsbt pushed a commit that referenced this pull request Jul 3, 2015
@nagachika
merge revision(s) 50793,51120: [Backport #11162]
306ed7c 
	* lib/cmath.rb: [DOC] Add docs [ci skip][Fix GH-909][Bug #11162]
	Patch provided by @davydovanton

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_2_2@51132 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
sonots pushed a commit to sonots/ruby that referenced this pull request Nov 17, 2015
@gogotanaka
* lib/cmath.rb: [DOC] Add docs [ci skip][Fix rubyGH-909][Bug ruby#11162]
41b6910 
Patch provided by @davydovanton

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@50793 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@gogotanaka gogotanaka

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@davydovanton @gogotanaka @DJGHOSTMACHINE
0