Uploaded image for project: 'MongoDB Database Tools'
  1. MongoDB Database Tools
  2. TOOLS-572

audit and revise --help text

    • Type: Icon: New Feature New Feature
    • Resolution: Done
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • Labels:
      None

      Check for capitalization, spelling, grammar, wording and tense.
      A lot of the help text is overly wordy/noisy/corny and in some cases gives less useful information than the legacy options.

      Some bad help text:

        -h, --host=                         Specify a resolvable hostname to which to connect
            --port=                         Specify the tcp port on which the mongod is listening
        -u, --username=                     Specify a user name for authentication
        -p, --password=                     Specify a password for authentication
      

      better:

        -h, --host=                         mongo host to connect to (setname/host1,host2 for replica sets)
            --port=                         server port. Can also use --host hostname:port
        -u, --username=                     user name for authentication
        -p, --password=                     password for authentication
      

            Assignee:
            kyle.erf Kyle Erf
            Reporter:
            mikeo@mongodb.com Michael O'Brien
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: