[JAVA-1715] API documentation change for class DBCollection Created: 21/Mar/15  Updated: 23/Mar/15  Resolved: 23/Mar/15

Status: Closed
Project: Java Driver
Component/s: Documentation
Affects Version/s: 3.0.0
Fix Version/s: 3.0.0, 2.14.0

Type: Bug Priority: Minor - P4
Reporter: Fabian Basciani Assignee: Ross Lawley
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

In the Javadoc for class DBCollection there is a mistake.

It is written for an example on how to use the class:
"MongoClient mongoClient = newMongoClient(newServerAddress("localhost", 27017));
DB db = mongo.getDB("mydb");
DBCollection collection = db.getCollection("test"); "

BUT when initialising DB it should say:
"DB db = mongoClient.getDB("mydb");"

as the MongoClient variable name is "mongoClient" and not "mongo".

Link to Javadoc: name.http://api.mongodb.org/java/current/com/mongodb/DBCollection.html



 Comments   
Comment by Ross Lawley [ 23/Mar/15 ]

Thanks nyanchan I've updated the docstring and the updated API documentation will be pushed in the forthcoming release.

Comment by Githook User [ 23/Mar/15 ]

Author:

{u'username': u'rozza', u'name': u'Ross Lawley', u'email': u'ross.lawley@gmail.com'}

Message: Fix documentation typo

JAVA-1715
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/e82f32baa63e9f987b51960251ce2a13353d34d3

Comment by Githook User [ 23/Mar/15 ]

Author:

{u'username': u'rozza', u'name': u'Ross Lawley', u'email': u'ross.lawley@gmail.com'}

Message: Fix documentation typo

JAVA-1715
Branch: 2.x
https://github.com/mongodb/mongo-java-driver/commit/eee58c194fe6f7353f84833793086863dde55f1b

Generated at Thu Feb 08 08:55:18 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.