Uploaded image for project: 'MongoDB Shell'
  1. MongoDB Shell
  2. MONGOSH-718

help text descriptions - distinguish between listings - function vs function call

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Open
    • Priority: Trivial - P5
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • # Replies:
      0
    • Last comment by Customer:
      true
    • Story Points:
      1

      Description

      I usually expect to see either commands or function calls rather than a mix of function objects and function calls, or to see them listed in a different format.

      Currently, I see function objects like "version" and function calls like "show" in the same list without any differentiation.

      Example:

      In the help text, "version" is described as "Shell version". This might lead me to believe that it is a function call, but when I type "version" at the prompt, I realize that it's a function object since it outputs:

      [Function (anonymous)] { help: [Function (anonymous)] Help }

      Thus, I figured out that should convert it to a function call "version()", but did not get that information from the help text. This could confuse some users that might not realize this difference and how to convert the function object to a function call.

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            chris.cho Christopher Cho
            Participants:
            Last commenter:
            Jessica Sigafoos Jessica Sigafoos
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Days since reply:
              14 weeks, 2 days ago
              Date of 1st Reply: