Improve first sentence

drbrain · drbrain · commit 5602b93d7445 · 2011-01-04T19:14:14.000-08:00
diff --git a/lib/rdoc/rdoc.rb b/lib/rdoc/rdoc.rb
@@ -382,12 +382,13 @@ def remove_unparseable files
   end
 
   ##
-  # Format up one or more files according to the given arguments.
+  # Generates documentation or a coverage report depending upon the settings
+  # in +options+.
   #
   # +options+ can be either an RDoc::Options instance or an array of strings
   # equivalent to the strings that would be passed on the command line like
-  # <tt>%w[-q -o doc -t My\ Doc\ Title]</tt>.
-  # #document will automatically call #finish on an RDoc::Options instance.
+  # <tt>%w[-q -o doc -t My\ Doc\ Title]</tt>.  #document will automatically
+  # call RDoc::Options#finish if an options instance was given.
   #
   # For a list of options, see either RDoc::Options or <tt>rdoc --help</tt>.
   #

Original file line number	Diff line number	Diff line change
`@@ -382,12 +382,13 @@ def remove_unparseable files`
`382`	`382`	`end`
`383`	`383`
`384`	`384`	`##`
`385`		`- # Format up one or more files according to the given arguments.`
	`385`	`+ # Generates documentation or a coverage report depending upon the settings`
	`386`	`+ # in +options+.`
`386`	`387`	`#`
`387`	`388`	`# +options+ can be either an RDoc::Options instance or an array of strings`
`388`	`389`	`# equivalent to the strings that would be passed on the command line like`
`389`		`- # <tt>%w[-q -o doc -t My\ Doc\ Title]</tt>.`
`390`		`- # #document will automatically call #finish on an RDoc::Options instance.`
	`390`	`+ # <tt>%w[-q -o doc -t My\ Doc\ Title]</tt>. #document will automatically`
	`391`	`+ # call RDoc::Options#finish if an options instance was given.`
`391`	`392`	`#`
`392`	`393`	`# For a list of options, see either RDoc::Options or <tt>rdoc --help</tt>.`
`393`	`394`	`#`