Project

General

Profile

Bug #8537

RDoc cannot parse ext/objspace

Added by zzak (Zachary Scott) over 4 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Target version:
ruby -v:
ruby 2.1.0dev (2013-06-16 trunk 41328) [x86_64-darwin12.3.0]
[ruby-core:55525]

Description

Maybe bug in rdoc or objspace extension

Associated revisions

Revision 41354
Added by Eregon (Benoit Daloze) over 4 years ago

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

Revision 41354
Added by Eregon (Benoit Daloze) over 4 years ago

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

Revision 41354
Added by Eregon (Benoit Daloze) over 4 years ago

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

Revision 41354
Added by Eregon (Benoit Daloze) over 4 years ago

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

Revision 41355
Added by Eregon (Benoit Daloze) over 4 years ago

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

Revision 41355
Added by Eregon (Benoit Daloze) over 4 years ago

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

Revision 41355
Added by Eregon (Benoit Daloze) over 4 years ago

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

Revision 41355
Added by Eregon (Benoit Daloze) over 4 years ago

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

Revision 41382
Added by zzak (Zachary Scott) over 4 years ago

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

Revision 41382
Added by zzak (Zachary Scott) over 4 years ago

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

Revision 41382
Added by zzak (Zachary Scott) over 4 years ago

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

Revision 41382
Added by zzak (Zachary Scott) over 4 years ago

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

History

#1 [ruby-core:55527] Updated by Eregon (Benoit Daloze) over 4 years ago

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.

#2 Updated by zzak (Zachary Scott) over 4 years ago

  • 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]

#3 [ruby-core:55542] Updated by Eregon (Benoit Daloze) over 4 years ago

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

zzak (Zachary Scott): 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) ?

#4 Updated by zzak (Zachary Scott) over 4 years ago

Eregon (Benoit Daloze) wrote:

zzak (Zachary Scott): 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.

#5 [ruby-core:55554] Updated by Eregon (Benoit Daloze) over 4 years ago

zzak (Zachary Scott) wrote:

Eregon (Benoit Daloze) wrote:

zzak (Zachary Scott): 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."

#6 [ruby-core:55556] Updated by zzak (Zachary Scott) over 4 years ago

  • Status changed from Open to Closed

Hi

Also available in: Atom PDF