From: Sam Rose <samwho@...>
Date: 2011-11-11T02:37:56+09:00
Subject: Re: Navigating through the official Ruby documentation

Okay, let's see...

http://www.ruby-doc.org/core-1.9.3/Array.html

Let's take the Array docs as an example. By the way you're talking,
I'm going to take a shot in the dark and guess you're used to the Java
API documentation? :) So you are familiar with the idea of static and
non-static methods (if not, just read on and see if it makes sense.
Otherwise ask).

In Ruby, static methods are described as "class methods". These are
methods that are not called from an instance of a class, but the class
itself. For example:

    Class.method_name(args)

Is how you would see a class method called. In the Ruby documentation,
these are prefixed with two colons ::

Non-static methods are referred to as "instance methods", and these
are called like so:

   c = Class.new
   c.some_method(args)

They're called in the instance of a class and in the Ruby
documentation these are prefixed with a hash (or pound if you're
American) #

The parent of a class is what the current class inherited from. In
Ruby, there's a hierarchy similarish to Java's. Everything inherits
from the Object class: http://ruby-doc.org/core-1.9.3/Object.html
(Object inherits from BasicObject for some reason, I would need to ask
someone else why this is, though, sorry :)).

If you don't understand object orientation, just say so and I'll find
you some good resources.

Modules are a really cool thing in Ruby. The "Included Modules"
section of a Ruby doc page tells you what modules the class is "mixing
in". I wrote an article about Ruby mixins, you can find it here:
http://samwho.co.uk/blog/2011/09/12/ruby-mixins/. It gives an overview
of what you can do with Ruby modules and likens them to similar
concepts in other languages that you might be more familiar with. If
you find that it confuses you, let me know where so I can reword it.

The "Class/Module Index" section of the page just looks like a list of
all classes in Ruby's standard library so you can quickly navigate
through them.

I hope this helps demystify the Ruby docs. Feel free to ask about
anything you're unsure of :)

On 10 November 2011 17:22, Fily Salas <fs_tigre@hotmail.com> wrote:
> Hi,
>
> I have been trying to learn Ruby and so far so good I'm slowly leering
> the basics. I was trying to start referring to the Docs but I'm a little
> confused, I was expecting to see a list of all Ruby classes and
> underneath the class name a list of all of its methods but it has more
> than just methods, I don’t know if I still need more knowledge about the
> language in order for me to understand the information provided in the
> official Ruby Docs.
>
> Class Name
>>>methods
> Class Name
>>>methods
>
> I see some methods start with a "#" some with "::" and than you have the
> following sections: In Files, Class/Module Index, Parent etc. I’m
> guessing  this has to do with Modules vs Classes.
>
> Can someone be so kind and go through the Ruby Docs and basically
> explain how is this organized?
>
> As I said I don't know if it’s because I don't fully understand the Ruby
> syntax or I simply need some adviceon how to use this documentation.
>
> Thanks a lot
>
> --
> Posted via http://www.ruby-forum.com/.
>