Uploaded image for project: 'IMPALA'
  1. IMPALA
  2. IMPALA-7550

Create documentation for all profile fields

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Critical
    • Resolution: Fixed
    • Impala 3.1.0
    • Impala 3.4.0
    • Docs

    Description

      It would be great to have some documentation for all profile fields. Currently users often have to look at the source code to figure out the exact meaning of a field. Instead we should investigate ways to generate documentation on the fields, e.g. by cleaning and automatically extracting relevant comments from the source code.

      Attachments

        Issue Links

          is duplicated by

          Task - A task that needs to be done. IMPALA-6836 Impala Doc: Refactor Query Profile doc

          • Major - Major loss of function.
          • Closed
          is related to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. IMPALA-7724 Improve Impala Profile User Experience

          • Major - Major loss of function.
          • Open
          relates to

          Improvement - An improvement or enhancement to an existing feature or task. IMPALA-7164 Define public API for RuntimeProfile

          • Major - Major loss of function.
          • Open

          Activity

            People

              jiawei.wang Jiawei Wang
              lv Lars Volker
              Votes:
              0 Vote for this issue
              Watchers:
              11 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: