Hi,
ruby-doc.org currently divides the Ruby documentation into core and
stdlib parts. This does not really work as if you look closely, there
are documents regarding DRB listed in the "Files" section at
<http://ruby-doc.org/core-2.3.1/>.
What's more problematic is that when you click on a library on the
<http://ruby-doc.org/stdlib-2.3.1/> page, you are shown a more or less
long list of classes that belong to that library. That list leaves it to
you to correctly guess which of these modules or classes may or may not
have the primary documentation entrance to that library. This is
acceptable for small libraries such as GDBM
(<http://ruby-doc.org/stdlib-2.3.1/libdoc/gdbm/rdoc/index.html>), where
this guess is easy enough. For REXML
(<http://ruby-doc.org/stdlib-2.3.1/libdoc/rexml/rdoc/index.html>) this
becomes fairly difficult. The Tk library mentioned in the other thread
is another example. Some libraries also just cause a 404, like Rake
<http://ruby-doc.org/stdlib-2.3.1/libdoc/rake/rdoc/index.html>.
Since actually a good number of libraries do have some documentation by
now, couldn't these pages be set up in such a way that they show the
main module's or class' documentation directly when a library is
selected, rather than leaving it to the user to guess where to look?
Greetings
Marvin
···
--
Blog: http://www.guelkerdev.de
PGP/GPG ID: F1D8799FBCC8BC4F
Another excellent point made by Marvin - for my part I have
"Programming Ruby
The Pragmatic Programmer's Guide"
installed on my system as part of the original Ruby install, which manages to "fill in the gaps"!!! I recommend this text to all Ruby newbies - especially as it is free!
···
On 20/09/2016 1:25 PM, Marvin Gülker wrote:
Hi,
ruby-doc.org currently divides the Ruby documentation into core and
stdlib parts. This does not really work as if you look closely, there
are documents regarding DRB listed in the "Files" section at
<http://ruby-doc.org/core-2.3.1/>\.
What's more problematic is that when you click on a library on the
<http://ruby-doc.org/stdlib-2.3.1/> page, you are shown a more or less
long list of classes that belong to that library. That list leaves it to
you to correctly guess which of these modules or classes may or may not
have the primary documentation entrance to that library. This is
acceptable for small libraries such as GDBM
(<http://ruby-doc.org/stdlib-2.3.1/libdoc/gdbm/rdoc/index.html>\), where
this guess is easy enough. For REXML
(<http://ruby-doc.org/stdlib-2.3.1/libdoc/rexml/rdoc/index.html>\) this
becomes fairly difficult. The Tk library mentioned in the other thread
is another example. Some libraries also just cause a 404, like Rake
<http://ruby-doc.org/stdlib-2.3.1/libdoc/rake/rdoc/index.html>\.
Since actually a good number of libraries do have some documentation by
now, couldn't these pages be set up in such a way that they show the
main module's or class' documentation directly when a library is
selected, rather than leaving it to the user to guess where to look?
Greetings
Marvin
--
Patrick Bayford Tel : 020 8265 8376 E-mail : pbayford@talktalk.net
I need to recommend against this particular work. It is totally out of
date as it was written for Ruby 1.6, unless the Programatic Programmers
publisher has finally decided to provide a newer version of the
"Pickaxe" (as this book is called colloquially) under a liberal
license. It might be worth if the MRI devs asked the publisher if it
would be willing to, as at least 1.8, the followup version, is now quite
old by now also.
The "Pickaxe" is still updated for current Ruby versions, so if you
like it, you might want to purchase the current version of it.
Greetings
Marvin
···
On Tue, Sep 20, 2016 at 09:44:15PM +0100, Patrick Bayford wrote:
Another excellent point made by Marvin - for my part I have
"Programming Ruby
The Pragmatic Programmer's Guide"
installed on my system as part of the original Ruby install, which
manages to "fill in the gaps"!!! I recommend this text to all Ruby
newbies - especially as it is free!
--
Blog: http://www.guelkerdev.de
PGP/GPG ID: F1D8799FBCC8BC4F
It's available for purchase from
Search. I thoroughly
recommend it.
Graham
···
On 21/09/2016 17:59, Marvin Gülker wrote:
On Tue, Sep 20, 2016 at 09:44:15PM +0100, Patrick Bayford wrote:
Another excellent point made by Marvin - for my part I have
"Programming Ruby
The Pragmatic Programmer's Guide"
installed on my system as part of the original Ruby install, which
manages to "fill in the gaps"!!! I recommend this text to all Ruby
newbies - especially as it is free!
I need to recommend against this particular work. It is totally out of
date as it was written for Ruby 1.6, unless the Programatic Programmers
publisher has finally decided to provide a newer version of the
"Pickaxe" (as this book is called colloquially) under a liberal
license. It might be worth if the MRI devs asked the publisher if it
would be willing to, as at least 1.8, the followup version, is now quite
old by now also.
The "Pickaxe" is still updated for current Ruby versions, so if you
like it, you might want to purchase the current version of it.
Greetings
Marvin