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

Set up guidelines for doc source formatting

    XMLWordPrintableJSON

Details

    • Task
    • Status: Closed
    • Trivial
    • Resolution: Feedback Received
    • Impala 2.7.0
    • None
    • Docs

    Description

      It's common for XML doc changes to produce "noisy" diffs due to the interaction between line wrapping within prose, verbose tags/attributes, and XML editor settings that adjust indentation, wrapping, etc. without the author being aware.

      This work item is to establish some guidance and potentially tooling to help make formatting consistent within the underlying XML source. The better to have concise diffs and easy-to-read gerrit review content.

      This is likely not needed pre-graduation, so creating this JIRA at a low priority. I don't mind moving it out of this umbrella task if having it here holds up closing the parent issue.

      Attachments

        Activity

          People

            arodoni Alexandra Rodoni
            jrussell John Russell
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: