Bug #1718
RDoc directive in lib/yaml/tags.rb prevents rdoc'ing of Module
| Status: | Closed | Start date: | 07/03/2009 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: | - | % Done: | 100% |
|
| Category: | - | |||
| Target version: | - | |||
| ruby -v: | ruby 1.8.6 (2009-03-27 patchlevel 367) [i686-darwin9.7.0] |
Description
This appears to be a regression. There is a :stopdoc: directive in lib/yaml/tags.rb that modifies Module. When running rdoc over the Ruby source tree, this stops the rdoc'ing of the entire Module code; no docs page for Module is created. This was a problem once before, and was fixed (I submitted a patch, which was accepted), but now seems to have returned. Removing that rdoc directive allows for Module to be doc'ed (though there is still the larger issue of RDoc pollution with Yaml methods now appearing as part of Module in the resulting RDoc files).
Associated revisions
Fix for Bug #1718 [ruby-core:24121]. Add a :startdoc into lib/yaml/tag.rb
History
Updated by Eric Hodel over 2 years ago
On Jul 2, 2009, at 14:06, James Britt <redmine@ruby-lang.org> wrote: > Bug #1718: RDoc directive in lib/yaml/tags.rb prevents rdoc'ing of > Module > http://redmine.ruby-lang.org/issues/show/1718 > > Author: James Britt > Status: Open, Priority: Normal > ruby -v: ruby 1.8.6 (2009-03-27 patchlevel 367) [i686-darwin9.7.0] > > This appears to be a regression. There is a :stopdoc: directive > in lib/yaml/tags.rb that modifies Module. > > When running rdoc over the Ruby source tree, this stops the > rdoc'ing of the entire Module code; no docs page for Module is > created. > > This was a problem once before, and was fixed (I submitted a patch, > which was accepted), but now seems to have returned. Removing that > rdoc directive allows for Module to be doc'ed (though there is still > the larger issue of RDoc pollution with Yaml methods now appearing > as part of Module in the resulting RDoc files). Pairing the stopdoc with a startdoc after the YAML methods should keep the Module documentation without the YAML additions.
Updated by Kirk Haines almost 2 years ago
- Status changed from Open to Closed
- % Done changed from 0 to 100
This issue was solved with changeset r26819. James, thank you for reporting this issue. Your contribution to Ruby is greatly appreciated. May Ruby be with you.