Print help for the global log property

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Done
    • Priority: Major - P3
    • 2.4.0
    • Affects Version/s: None
    • Component/s: Help, Logging
    • None
    • 3
    • Iteration U (Jan 27 - Feb 10), Iteration Venus
    • Needed
    • Hide

      Do we show somewhere in the documentation the top-level help commands? If not, then documentation changes are not needed. If we do, we now show the `log` command help.

      Show
      Do we show somewhere in the documentation the top-level help commands? If not, then documentation changes are not needed. If we do, we now show the `log` command help.
    • Developer Tools

      Users should be able to see help for the `log.info()`, `log.warn()`, etc methods.

      Currently, the `shellApiClassDefault` decorator provides help info (@mongosh/i18n) only for ShellApi methods. We should change the `shellApiClassGeneric` method so it also supports properties like `log`.

       

        1. Screenshot 2025-01-23 at 14.05.26.png
          234 kB
          Alena Khineika

            Assignee:
            Alena Khineika
            Reporter:
            Alena Khineika
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: