[#2367] Standard libraries — Dave Thomas <dave@...>

From ruby-dev summary:

60 messages 2004/02/11

[#2397] PATCH: deprecate cgi-lib, getopts, importenv, parsearg from standard library — Gavin Sinclair <gsinclair@...>

Index: cgi-lib.rb

15 messages 2004/02/12

[#2465] PATCH: OpenStruct#initialize to yield self — Gavin Sinclair <gsinclair@...>

This is a common approach I use to object initialization; I don't know

24 messages 2004/02/19

Re: Standard libraries

From: Dave Thomas <dave@...>
Date: 2004-02-13 18:04:45 UTC
List: ruby-core #2439
On Feb 13, 2004, at 11:52, J.Herre wrote:

> What I'm doing with an extension I'm trying to write today is to use 
> rdoc to weave a README.en from the makefile so that someone who just 
> downloads it will have something to read immediately.
>

What I've done is create a README in RDoc format, and then use 
:include: to include it in the documentation for the main class. That 
way I don't add too much to the class itself, and people can find the 
README when they look for it.

> But there's also the problem of much of this style of documentation 
> not making it into ri.  For instance, it would be great if 'ri rdoc' 
> produced an overview of rdoc, or if 'ri soap4r' did likewise.  It'd be 
> even better if 'ri -k soap' produced a list of soap facilities in 
> ruby.

Good ideas both. Let me see how to do it. (To be fair, though, ri soap 
will currently list all methods with 'soap' in their name.)



Cheers

Dave


In This Thread