From: "drbrain (Eric Hodel)" <drbrain@...7.net>
Date: 2012-08-30T06:12:36+09:00
Subject: [ruby-core:47365] [ruby-trunk - Bug #6929] Documentation for Ripper


Issue #6929 has been updated by drbrain (Eric Hodel).


=begin
When ((%make rdoc%)) runs it starts at the root and looks for ".document" files in the current directory.  These files contain the paths that RDoc is allowed to traverse.  Subdirectories may contain .document files, and ext/.document contains paths for ripper which expand to "ext/ripper/ripper.c" and "ext/ripper/lib".

If you run RDoc by hand you need to take into account the contents of the .document file.  If you have:

  rdoc ext/ripper

RDoc won't look in ext/.document or .document to determine which paths it should exclude or include.  You need to run:

  rdoc ext/ripper/ripper.c ext/ripper/lib

PS: Perhaps looking for .document files between the current directory and the source directory should be an option in RDoc
=end

----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29099

Author: zzak (Zachary Scott)
Status: Open
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library Ripper.

As always, feedback welcome.


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