[ruby-core:55554] [ruby-trunk - Bug #8537] RDoc cannot parse ext/objspace

Issue #8537 has been updated by Eregon (Benoit Daloze).


zzak (Zachary Scott) wrote:
> Eregon (Benoit Daloze) wrote:
> > @zzak: The overview of objspace ext comes before the general doc for ObjectSpace,
> > is that avoidable?
> 
> What do you mean?

See https://gist.github.com/eregon/bf86d335fdc9a36d96c0

> > Also, with r41380, I cannot know anymore using for instance `ri ObjectSpace.memsize_of` that I need to require 'objspace' to use it. Is it clear on the html page generated (from which lib/ext do methods come) ?
> 
> I think we should add doc to say 'extension method', the whole require bit is a bit redundant.

It is redundant at source level but not so much when browsing documentation.
Unless there is a clear way to link to which method is introduced by which extension,
I think it is needed to "link manually" and not sure something like
"this methods belongs to the objspace library" is better than "You need to require 'objspace' to use this method."
----------------------------------------
Bug #8537: RDoc cannot parse ext/objspace
https://bugs.ruby-lang.org/issues/8537#change-40052

Author: zzak (Zachary Scott)
Status: Open
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: ext
Target version: current: 2.1.0
ruby -v: ruby 2.1.0dev (2013-06-16 trunk 41328) [x86_64-darwin12.3.0]
Backport: 1.9.3: UNKNOWN, 2.0.0: UNKNOWN


Maybe bug in rdoc or objspace extension


-- 
http://bugs.ruby-lang.org/