Uploaded image for project: 'C++ Driver'
  1. C++ Driver
  2. CXX-1087

Public method documentation for command helpers should point users to command reference, not shell method reference

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Minor - P4
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.2.0-rc0
    • Component/s: Documentation
    • Labels:
      None
    • Sprint:
      Perl/CXX 2016-12-23

      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());
      

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: