Bug #2320
closedpatch to trunk .document to include more readme's etc.
Description
=begin
This patch adds some README files to default rdoc's of trunk [ex: README and README.EXT] and I propose its consideration.
Thanks!
-r
=end
Files
Updated by naruse (Yui NARUSE) over 14 years ago
=begin
Where is the patch?
=end
Updated by naruse (Yui NARUSE) over 14 years ago
- Category set to doc
- Status changed from Open to Feedback
=begin
=end
Updated by rogerdpack (Roger Pack) over 14 years ago
- File dot_document.diff dot_document.diff added
=begin
Sorry here's the patch.
Note that rdoc doesn't actually parse all files until a patch is applied [1].
Thanks!
-r
[1] http://rubyforge.org/tracker/index.php?func=detail&aid=27388&group_id=627&atid=2474
=end
Updated by naruse (Yui NARUSE) over 14 years ago
- Status changed from Feedback to Closed
- % Done changed from 0 to 100
=begin
This issue was solved with changeset r25649.
Roger, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.
=end
Updated by usa (Usaku NAKAMURA) over 14 years ago
- Status changed from Closed to Open
=begin
Why you added no-rdoc-format files such as ChangeLog?
=end
Updated by rogerdpack (Roger Pack) over 14 years ago
=begin
I considered ChangeLog still useful to end users in terms of documentation (same with licensing information). Thoughts?
-r
=end
Updated by naruse (Yui NARUSE) over 14 years ago
=begin
I think so too. Those files have reason to bundle even if they are not in rdoc.
=end
Updated by usa (Usaku NAKAMURA) over 14 years ago
=begin
Hello,
In message "[ruby-core:26688] [Bug #2320] patch to trunk .document to include more readme's etc."
on Nov.12,2009 00:58:17, redmine@ruby-lang.org wrote:
I think so too. Those files have reason to bundle even if they are not in rdoc.
I do not ask the judgment which documents to bundle.
I ask why do you added the files those are not the rdoc format
to .document.
Have you read the comment of the file?
Have you never seen the error message that rdoc always says in
generating phase?
Regards,¶
U.Nakamura usa@garbagecollect.jp
=end
Updated by naruse (Yui NARUSE) over 14 years ago
- Status changed from Open to Closed
=begin
This issue was solved with changeset r25724.
Roger, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.
=end