Update code style to reflect current use of FIXME comments

XMLWordPrintableJSON

    • Type: Documentation
    • Resolution: Unresolved
    • Priority: Minor - P4
    • None
    • Affects Version/s: None
    • Component/s: Documentation
    • None
    • Storage Engines
    • None
    • None

      The WT coding style says that "Comments should ... not reference Jira ticket numbers nor pull request number."

      Today, however, we routinely use comments of the form FIXME-WT-99999 to indicate deficiencies or opportunities for improvement in the code and provide a pointer to an existing open ticket. This is useful and widely used. A quick search shows over 70 tickets referenced this way. We have also built this into our process, with tools like s_mentions that ensure these comments don't remain when the corresponding ticket is closed.

      This is all to say, that we should update our coding style to reflect our current practice.

            Assignee:
            Keith Smith
            Reporter:
            Keith Smith
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: