Documentation

Hi all,

I am starting to play with Ruby but I am really confused on where to
find decent documentation.
I was writing a simple program that uses Find to iterate over files and
calculates MD5 digests for every file. So for every found file I use
File.read to read it and compute the MD5. I have found the following
(frustrating) problems:

1) By looking at the documentation File.read doesn't exist as a method.
However by it seems that File is a subclass of IO that actually
contains read. But this is not clearly specified in the documentation
(it is only mentioned that it is closely associated with class IO,
whatever this means)

2) Exceptions... File.read raises an exception if, for example, I try
to read a file that requires higher access privileges. Again, the
documentation doesn't provide any kind of information of what type of
exceptions can be raised.

Is it RI the best source of documentation?
Where can I find a better one?

Thanks

.

Relevant Pages

  • Re: CLOS and C++
    ... > relative percentage of needing to know the exceptions a given method can raise ... >> with the information provided by the mandatory type declarations. ... javadoc comments and put it into the class file and then change the ... attach the documentation directly to the elements its documenting so ...
    (comp.lang.lisp)
  • Re: SqlConnection.Open() Which ErrorCodes
    ... exceptions is that they are often too generic and the ... Hitchhiker's Guide to Visual Studio and SQL Server ... the documentation in the .NET Framework Help for these classes: ...
    (microsoft.public.dotnet.framework.adonet)
  • Re: Problems Handling Errors Correctly
    ... But as with your observation about the .NET Framework itself, to some extent this is a consequence of the sheer size of the Framework. ... One hopes that over time, the documentation will get filled in, but it's not hard to see why some things may have been considered lower priority and receive a basic "template" documentation rather than a fully useful description. ... the docs include a section immediately after the "Return Value" section enumerating possible exceptions. ... If it's not the case, or it's incomplete, or it leaves out exceptions that could be thrown my methods called from the method, that would really be a drag. ...
    (microsoft.public.dotnet.languages.csharp)
  • Re: O/T: Quote Of THe Day
    ... complexities of current life are completely different now compared to ... programs of proposed protocols, and documentation, documentation, ... forms of legalese with exceptions and exceptions to the exceptions. ... So let us do away with the HIPAA forms and everything analogous, ...
    (rec.woodworking)
  • Re: a criticism of java
    ... > Am I to take this to mean that documentation needs to duplicate the ... I was really only referring to after the throws clause. ... appeared to me to not agree with unchecked exceptions, ... > is better expressed in the language. ...
    (comp.lang.java.programmer)