Uploaded image for project: 'VS Code Extension'
  1. VS Code Extension
  2. VSCODE-238

Show contextual documentation in autocomplete popups

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.5.0
    • Component/s: None
    • Labels:
      None
    • Documentation Changes:
      Needed
    • Documentation Changes Summary:
      Not sure if this is worth mentioning in the docs: the autocomplete popup in playgrounds now displays information about each command and links out to the online documentation if user wants to read more.

      Description

      In mongosh we maintain contextual documentation for the whole Shell API and VS Code allows us to display it to the user in the autocomplete popup.

      By putting the two things together, we can expose this contextual information when the user is editing code in playgrounds and get a quick overview of what each command does.

        Attachments

          Activity

            People

            Assignee:
            massimiliano.marcon Massimiliano Marcon
            Reporter:
            massimiliano.marcon Massimiliano Marcon
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: