Proper Documentation

(manveru) #1

Hi list,

I´m a bloody newbie in ruby, and the only thing worth to be called language i learned was php.
although it´s really fun and really enlightening for me to learn ruby, there is one thing i miss:
ruby has no documentation that i am able to understand as a newcomer.
while that may be a lack of intelligence on my side, i don´t think that is the reason ^^
i slapped my brain around with the way to program OO, and as i finally begin to understand how that is done, i imagine there are better ways to learn it and i have gone through unnecessary pain.
there is the Pragmatic Programmers Guide (http://www.rubycentral.com/book/) and that´s it. (at least i didn´t see any other tutorials)
i have learned a lot through that tutorial, and maybe i really have to buy all the ruby-books at amazon to stay up to date with changes on ruby.

i really would like a kind of php.net (http://www.php.net) for ruby, and i am willing to contribute an enormous amount of time into a thing like that (but well, i´m a noob - i can´t do that myself)
is there something like that? (maybe in some alpha-stage?)
i know ruby-docs, but that helps only when you have understood it already
is there some tutorial on OO itself? so we could use it and write a ruby-version of it...

i don´t know if i´m only ignorant of the whole ruby-sphere out there, or if it really exists only in japanese...

thx for your contribution
Michael Fellinger

(Johan Toki Persson) #2

Try these

http://www.ruby-lang.org/en/20020103.html
http://www.rubygarden.org/ruby?RubyNuby
http://www.rubygarden.org/ruby?RubyBookList

Cheers

(Martin Larsson) #3

And this:

http://www.poignantguide.net/ruby/

manveru wrote:

···

<snip>

thx for your contribution
Michael Fellinger

(Randy Kramer) #4

i have learned a lot through that tutorial, and maybe i really have to
buy all the ruby-books at amazon to stay up to date with changes on ruby.

i really would like a kind of php.net (http://www.php.net) for ruby, and
i am willing to contribute an enormous amount of time into a thing like
that (but well, i´m a noob - i can´t do that myself)
is there something like that? (maybe in some alpha-stage?)

There are other (online) tutorials (and dead tree books), but WikiLearn
(http://twiki.org/cgi-bin/view/Wikilearn/WebChanges) is intended to be my
"learning notebook" "project", and I'm always looking for help.

I'm making a renewed effort to learn Ruby, and would like to record my
learnings on WikiLearn. (I've done more recording of my learnings off line
recently as I've gradually found updating TWiki to be a little slower than
I'd like--one of the things I'm hoping to create with Ruby are some tools to
make such updating much more convenient and faster.)

Part of my goal is to make things simple. Reading part of Programming Ruby
2nd edition today, I summarized part of the chapter on exceptions as follows:

begin

   <try to do something>

rescue

   <if it fails, do this>
   
ensure

   < whether it succeeds or fails, do this>

end

(I've got some similar "summaries" that include multiple exceptions, else, and
retry.)

I'd love to have your contributions to WikiLearn.

i know ruby-docs, but that helps only when you have understood it already
is there some tutorial on OO itself? so we could use it and write a
ruby-version of it...

If you (or anyone else) is interested, let me know, or just go to WikiLearn
and start creating pages. (Eventually I'll move WikiLearn to its own site
(separate from twiki.org), when I do, I'll create (one or more) separate
web(s) for Ruby--for the time being I'll separate the Ruby contents by a
prefix (or suffix) on page names. (The first thought is simply a prefix of
Ruby.)

regards,
Randy Kramer

PS: One of my "handicaps" has been learning the oop idiom, coming from a
background in procedural type programming, so I'm interested and familiar
with the problems of doing so. If you're coming from a similar background,
let me know, I think I can come up with some suggestions that might help.

···

On Monday 08 August 2005 01:24 pm, manveru wrote:

(Daniel Amelang) #5

Don't forget to check out ruby-doc.org.

Dan

(Chris Pine) #6

I wrote a tutorial (soon to be book). It's fairly popular, I think;
it showed up in del.icio.us/popular recently, anyway. :slight_smile:

  http://pine.fm/LearnToProgram/

It's pretty gentle, and many have learned Ruby by it over the years.
And I always encourage you to email me if you find something in it
that confuses you.

Between that and the other great resources presented here, you should
have no trouble finding your footing.

Welcome to Ruby!

Chris

(Ben Giddings) #7

Hi Michael,

It would be great if you can take notes as you go. As Rails and web-applications in Ruby grow more popular, I'm sure we'll have more and more converts from PHP. It would be really handy to have a set of notes that say "If you're used to doing X in PHP, in Ruby you do it as Y". The lack of uniform, available, well-focused documentation is a known problem in Ruby, but we do want to fix it. One place to start is redesigning the web site. We're working on that. If you can think of specific ideas to make things better, we'd love to hear.

As a general case, eventually I think we'd love to have special documentation on transitioning from various other languages to Ruby, but unless you've recently done that transition, or can pick the brain of someone who did, it's hard to know what to say. PHP to Ruby is one bit of info we really know we need. Another is Perl to Ruby, and Python to Ruby. There is more info out there on Java to Ruby, but it seems to be pretty scattered.

I hope your Ruby learning experience ends up being a pleasant one!

Ben

(basi) #8

Hi,
Sounds like a good book for me. But Attempting to connect to
http://pine.fm/LearnToProgram/
times out.
basi

(James Britt) #9

Daniel Amelang wrote:

Don't forget to check out ruby-doc.org.

http://www.ruby-doc.org/gettingstarted/

as well as

   http://www.ruby-doc.org/core/

and

   http://www.ruby-doc.org/stdlib/

James

···

--

http://www.ruby-doc.org - The Ruby Documentation Site
http://www.rubyxml.com - News, Articles, and Listings for Ruby & XML
http://www.rubystuff.com - The Ruby Store for Ruby Stuff
http://www.jamesbritt.com - Playing with Better Toys

(Chris Pine) #10

Sounds like a good book for me. But Attempting to connect to
http://pine.fm/LearnToProgram/

Odd. It's working for me now, anyway. And was then. Maybe it went
down briefly, but it is almost always up.

:slight_smile:

Chris

(basi) #11

Yes, it is up now. Thanks.
basi