Project

General

Profile

Bug #4762

Adding documentation for mathn

Added by anilv (Anil V) about 9 years ago. Updated about 9 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
ruby -v:
1.9.2-p180
Backport:
[ruby-core:36380]

Description

I added documentation for using mathn. Added examples for using Prime, Vector & Matrix. Maintained the Rdoc format.

Patch included.


Files

Updated by drbrain (Eric Hodel) about 9 years ago

Is part of this patch missing? I can't find the context for this patch, for example, I can't find "will return Matrix" or "will retrun Matrix" in svn trunk.

Updated by anilv (Anil V) about 9 years ago

You're right. I did not include the original patch. Sorry about that.

I am adding both the patches now. The second one is just correcting spelling errors on my part.

Just ignore the first file from 5/21 :: 0001-Fixed-typos-on-mathn-documentation.patch

Thanks!

#4

Updated by drbrain (Eric Hodel) about 9 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r31881.
Anil, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • lib/mathn.rb: Improve documentation and attach it to Numeric. Modified from patch by Anil V. [Ruby 1.9 - Bug #4762]

Updated by drbrain (Eric Hodel) about 9 years ago

Since there were other commits to mathn.rb before I received your patch I applied a modified version.

I added a note to prime.rb mentioning that it is Enumerable. Since Prime already has good documentation I don't think there's a good place to add the rest of your examples.

For Matrix and Vector they don't have much toplevel documentation, so I think that would be a good next place for you to submit a patch.

Updated by anilv (Anil V) about 9 years ago

Awesome! Thanks Eric.

Also available in: Atom PDF