Add note for rdoc_dir option

zzak · Mar 14, 2016 · 1f1bc49 · 1f1bc49
1 parent 304e45a
commit 1f1bc49
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/README.md b/README.md
@@ -62,7 +62,7 @@ require 'sdoc' # and use your RDoc task the same way you used it before
 require 'rdoc/task' # ensure this file is also required in order to use `RDoc::Task`
 
 RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.rdoc_dir = 'doc/rdoc' # name of output directory
   rdoc.options << '--fmt' << 'shtml' # explictly set shtml generator
   rdoc.template = 'direct' # lighter template used on railsapi.com
   ...