Re: RDoc not ignoring sections of file

On Thursday, March 11, 2004, 12:38:02 AM, jbritt wrote:

> Ian Macdonald wrote:
>> Hello,
>> 
>> When wanting rdoc to avoid documenting a constant intended for private
>> use only, this kind of thing used to work:
>> 
>>    #--
>>    DEFAULT_ID  = { 'us' => 'foo',
>>                    'uk' => 'bar',
>>                    'de' => 'baz',
>>                    'jp' => 'qux'
>>    } 
>>    #++ 
>> 
>> However, at some point in the recent past, this stopped working.
>> Attaching '# :nodoc' to the final brace doesn't work either.

> Dave Thomas, the creator/maintainer of RDoc, is not (to my knowledge) a
> member of the ruby-doc list.  You might do well to post to either 
> ruby-talk or ruby-core.

That's good practical advice for reporting an actual problem, but I
think it's good to run RDoc-related issues by here as well, for a
couple of reasons.

Firstly, more often than not it's a matter of the user not being sure
how to accomplish something.  That can be easily corrected here, and
the archives will be the richer for it.  Of course the same logic
applies to other lists as well, but this *is* a documentation-related
list.

Secondly, Dave is very busy, RDoc is a big project, and the lines of
reporting are not always clear (sourceforge?, direct mail?, a mailing
list?).  This list can provide a valuable service by being a first
line of support for RDoc, taking some heat off Dave.  Only a little,
but the spread of knowledge is valuable, I think.  What do others
think?

As an aside, I think a great boost for RDoc would be for someone to
take over maintenance (to whatever extent is appropriate).  That's my
opinion, not necessarily Dave's.  But Dave takes a "show me the patch"
attitude to feature suggestions nowadays, so he obviously welcomes
contributions.

Cheers,
Gavin