From 75ff1aa63348d42993e48148f4e1e78bfb4848c5 Mon Sep 17 00:00:00 2001 From: Kyle Banker Date: Tue, 6 Sep 2011 16:36:45 -0400 Subject: [PATCH] minor: doc fixes --- Rakefile | 2 +- docs/HISTORY.md | 4 ++-- lib/mongo/collection.rb | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Rakefile b/Rakefile index e8bbe5b..273753d 100644 --- a/Rakefile +++ b/Rakefile @@ -141,7 +141,7 @@ task :ydoc do require File.join(File.dirname(__FILE__), 'lib', 'mongo') out = File.join('ydoc', Mongo::VERSION) FileUtils.rm_rf('ydoc') - system "yardoc lib/**/*.rb lib/mongo/**/*.rb lib/bson/**/*.rb -e ./yard/yard_ext.rb -p yard/templates -o #{out} --title MongoRuby-#{Mongo::VERSION} --files docs/TUTORIAL.md,docs/GridFS.md,docs/FAQ.md,docs/REPLICA_SETS.md,docs/WRITE_CONCERN.md,docs/READ_PREFERENCE.md,docs/HISTORY.md,docs/CREDITS.md,docs/RELEASES.md" + system "yardoc lib/**/*.rb lib/mongo/**/*.rb lib/bson/**/*.rb -e ./yard/yard_ext.rb -p yard/templates -o #{out} --title MongoRuby-#{Mongo::VERSION} --files docs/TUTORIAL.md,docs/GridFS.md,docs/FAQ.md,docs/REPLICA_SETS.md,docs/WRITE_CONCERN.md,docs/READ_PREFERENCE.md,docs/HISTORY.md,docs/CREDITS.md,docs/RELEASES.md,docs/CREDITS.md,docs/TAILABLE_CURSORS.md" end namespace :bamboo do diff --git a/docs/HISTORY.md b/docs/HISTORY.md index c4fa2d2..8cec37c 100644 --- a/docs/HISTORY.md +++ b/docs/HISTORY.md @@ -48,8 +48,8 @@ UNRELEASED * Fix the exception message shown when there's an IOError (Mauro Pompilio) * Another update to map-reduce docs for v1.8. Note that if you use the new - output option {:out => {:inline => true}}, then you must also specify - :raw => true. + output option `{:out => {:inline => true}}`, then you must also specify + `:raw => true`. ### 1.2.3 2011-2-22 diff --git a/lib/mongo/collection.rb b/lib/mongo/collection.rb index a9a1ef8..adb9af0 100644 --- a/lib/mongo/collection.rb +++ b/lib/mongo/collection.rb @@ -590,12 +590,12 @@ module Mongo # @option opts [Boolean ] :verbose (false) if true, provides statistics on job execution time. # @option opts [Boolean] :raw (false) if true, return the raw result object from the map_reduce command, and not # the instantiated collection that's returned by default. Note if a collection name isn't returned in the - # map-reduce output (as, for example, when using :out => {:inline => 1}), then you must specify this option + # map-reduce output (as, for example, when using :out => { :inline => 1 }), then you must specify this option # or an ArgumentError will be raised. # # @return [Collection, Hash] a Mongo::Collection object or a Hash with the map-reduce command's results. # - # @raise ArgumentError if you specify {:out => {:inline => true}} but don't specify :raw => true. + # @raise ArgumentError if you specify { :out => { :inline => true }} but don't specify :raw => true. # # @see http://www.mongodb.org/display/DOCS/MapReduce Offical MongoDB map/reduce documentation. #