Skip to content

Commit 5f7d136

Browse files
committed
Build yard docs to yard-docs and update gitignore
1 parent fffba73 commit 5f7d136

File tree

5 files changed

+9
-5
lines changed

5 files changed

+9
-5
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
.yardoc
1414
coverage
1515
data
16-
docs
16+
yard-docs
1717
Gemfile.lock
1818
.ruby-gemset
1919
.ruby-version

.yardopts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
lib/**/*.rb
1+
lib/**/*.rb
2+
-o yard-docs

lib/mongo/dbref.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ def initialize(collection, id, database = nil)
7979
# @example Convert the DBRef to raw BSON.
8080
# dbref.to_bson
8181
#
82-
# @param [ String ] buffer The encoded BSON buffer to append to.
82+
# @param [ BSON::ByteBuffer ] buffer The encoded BSON buffer to append to.
83+
# @param [ true, false ] validating_keys Whether keys should be validated when serializing.
8384
#
8485
# @return [ String ] The raw BSON.
8586
#

lib/mongo/grid/file/chunk.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,8 @@ def initialize(document)
130130
# @example Convert the chunk to BSON.
131131
# chunk.to_bson
132132
#
133-
# @param [ String ] buffer The encoded data buffer to append to.
133+
# @param [ BSON::ByteBuffer ] buffer The encoded BSON buffer to append to.
134+
# @param [ true, false ] validating_keys Whether keys should be validated when serializing.
134135
#
135136
# @return [ String ] The raw BSON data.
136137
#

lib/mongo/grid/file/info.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,8 @@ def md5
196196
# @example Convert the file information document to BSON.
197197
# file_info.to_bson
198198
#
199-
# @param [ String ] encoded The encoded data to append to.
199+
# @param [ BSON::ByteBuffer ] buffer The encoded BSON buffer to append to.
200+
# @param [ true, false ] validating_keys Whether keys should be validated when serializing.
200201
#
201202
# @return [ String ] The raw BSON data.
202203
#

0 commit comments

Comments
 (0)