Uploaded image for project: 'Network Observability'
  1. Network Observability
  2. NETOBSERV-2646

CLI help doc issues, missing examples

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • None
    • CLI
    • None
    • False
    • Hide

      None

      Show
      None
    • None
    • None
    • None
    • None
    • NetObserv - Sprint 284
    • None
    • None
    • None

      Description of problem:

      the CLI --help does not behave very consistently between global help and subcommand help. Generally in CLI tools, it is expected that subcommand help add more precision over global help, but it's only partly the case in our CLI, because all the examples are missing in subcommand helps.

We should organize examples so that they're visible in subcommand help too.

      Steps to Reproduce:

      1. Run "oc netobserv --help" => examples are displayed
2. Run "oc netobserv flows --help" => examples are not displayed
3.

       

      Related discussion (internal) : https://redhat-internal.slack.com/archives/C01DMAD88JF/p1771841215154769?thread_ts=1771837445.014709&cid=C01DMAD88JF 

              jtakvori Joel Takvorian
              jtakvori Joel Takvorian
              None
              None
              None
              Oliver Smakal Oliver Smakal
              None
              Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: