Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-3992

generate-doc.ts has a bug with local variables being documented in generation

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Won't Do
    • Icon: Undefined Undefined
    • None
    • 4.10
    • Management Console
    • None
    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • None
    • Low
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Description of problem:

      We have an issue where a local variable will be consumed by the doc generation and given a public entry into our API.md.
      
      This was the case for the local variable (that was not exported out of the module) _usePrometheusPoll (with the underscore).
      
      We should be able to create local variables and not have them generated in the documentation when we run the script.

      Additional info:

      Migrated from https://bugzilla.redhat.com/show_bug.cgi?id=2096919

              rh-ee-jonjacks Jon Jackson
              rh-ee-jonjacks Jon Jackson
              None
              None
              YaDan Pei YaDan Pei
              None
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: