Uploaded image for project: 'MongoDB CLI Tools'
  1. MongoDB CLI Tools
  2. TOOLS-846

--help output is somewhat unclear about defaults and explicit settings

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.1.8
    • Component/s: None
    • Labels:
      None

      Description

      running --help on any of the tools shows which options can be set vs. which options are standalone by appending an = sign to them. This can be confusing when text in the description says things like "If no path is passed in, will default to std out"

      Which can make it somewhat unclear when people see something like out=

      and assume out= will write to stdout when in fact it will ignore the flag since it parses it as the null string.

      Instead of the = signs we probably want it to say something like "is settable" as opposed to a flag like --gzip which is not settable.

      It's a subtle documentation change that should make things more clear.

        Attachments

          Activity

            People

            Assignee:
            gabriel.russell Gabriel Russell
            Reporter:
            osmar.olivo Osmar Olivo
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: