Bug #8537: RDoc cannot parse ext/objspace

• Status: Closed
• Assignee: drbrain (Eric Hodel)
• Target version: 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

[zzak (zzak _)]

Maybe bug in rdoc or objspace extension

[Eregon (Benoit Daloze)]

I made a couple changes and it now appears in ri ObjectSpace,
but only when I generate again the documentation (for example, by touching ext/objspace/objspace.c),
not when make clean && make install (only the non-extension description is shown).

It definitely sounds as a RDoc bug therefore.

I also made rdoc know about the extension methods.

[zzak (zzak _)]

• Status changed from Open to Closed
• % Done changed from 0 to 100

This issue was solved with changeset r41382.
Zachary, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

---

• ext/objspace/object_tracing.c: Teach rdoc object_tracing.c [Bug #8537]

[Eregon (Benoit Daloze)]

• Status changed from Closed to Open
• % Done changed from 100 to 0

@zzak (zzak _): The overview of objspace ext comes before the general doc for ObjectSpace,
is that avoidable?

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) ?

[zzak (zzak _)]

Eregon (Benoit Daloze) wrote:

@zzak (zzak _): The overview of objspace ext comes before the general doc for ObjectSpace,
is that avoidable?

What do you mean?

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.

[Eregon (Benoit Daloze)]

zzak (Zachary Scott) wrote:

Eregon (Benoit Daloze) wrote:

@zzak (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."

[zzak (zzak _)]

• Status changed from Open to Closed

Hi

[Eregon (Benoit Daloze)]

• gc.c (ObjectSpace): is a module not a class.
• ext/objspace/objspace.c: try to include overview in rdoc,
  see #8537.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@41354 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

[Eregon (Benoit Daloze)]

• ext/objspace/objspace.c: let rdoc know about objspace methods.
  Specify 'objspace' should be required. See #8537.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@41355 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

[zzak (zzak _)]

• ext/objspace/object_tracing.c: Teach rdoc object_tracing.c [Bug #8537]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@41382 b2dd03c8-39d4-4d8f-98ff-823fe69b080e