13

I can't find the full documentation of the Mail gem https://github.com/mikel/mail

For the documentation, all links are to the main github page, but the readme is far from complete. Is there any alternative to search everything in the source code?

Dan Mazzini
  • 1,005
  • 10
  • 19
  • 1
    The README is pretty good, but where it hasn't included what I need, I've just dived into the code, which is pretty well laid out. – d11wtq Jun 08 '12 at 13:23
  • I dived into the code too for now, but it is very unconvenient. Anyway, thank you for the suggestion. – Dan Mazzini Jun 08 '12 at 14:00
  • 3
    You can also view the rdoc documentation on ruby-doc.org and on the yard site. http://www.ruby-doc.org/gems/docs/m/mail-2.4.4/ and http://rubydoc.info/gems/mail/frames – d11wtq Jun 08 '12 at 14:08
  • Thank you @d11wtq ! I solved the immediate problem, but that was exactly what I was looking for. If you post it as answer, I'll accept it :) – Dan Mazzini Jun 13 '12 at 09:12

2 Answers2

4

Per @d11wtq in the comments above you can find the rdoc documentation on ruby-doc.org and rubydoc.info

martin
  • 1,185
  • 17
  • 22
Egryan
  • 717
  • 4
  • 15
1

If you installed the gem with the documentation, you could run a local gem documentation server by running:

gem server

It will tell you where it's accessible. Connect with your web browser and look for the mail gem. There's more documentation there.

Philippe Green
  • 894
  • 7
  • 10