[CXX-1087] Public method documentation for command helpers should point users to command reference, not shell method reference Created: 12/Oct/16  Updated: 20/Dec/16  Resolved: 15/Dec/16

Status: Closed
Project: C++ Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 3.2.0-rc0

Type: New Feature Priority: Minor - P4
Reporter: J Rassi Assignee: Samuel Rossi (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

Currently, many command helpers in the driver have an @see link that points users to the documentation for the corresponding shell helper for the command, instead of the documentation for the command itself. This can be confusing, since the parameters for the shell helper can differ from the options accepted by the command, and the shell helper can exhibit behavior that the driver helper does not.

For example, see the below method documentation for database::create_collection():

 95     ///
 96     /// Explicitly creates a collection in this database with the specified options.
 97     ///
 98     /// @see http://docs.mongodb.org/manual/reference/method/db.createCollection/
 99     ///
100     /// @param name the new collection's name.
101     /// @param options the options for the new collection.
102     ///
103     /// @throws mongocxx::operation_exception if the operation fails.
104     ///
105     class collection create_collection(
106         bsoncxx::string::view_or_value name,
107         const options::create_collection& options = options::create_collection());



 Comments   
Comment by Githook User [ 15/Dec/16 ]

Author:

{u'username': u'saghm', u'name': u'Saghm Rossi', u'email': u'saghmrossi@gmail.com'}

Message: CXX-1087 Public method documentation for command helpers should point users to command reference, not shell method reference
Branch: master
https://github.com/mongodb/mongo-cxx-driver/commit/fe13427277570435011c678e8f666bfc3a10b51c

Generated at Wed Feb 07 22:01:21 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.