Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-7892

Transfer relevant C++ doc guidelines from Confluence to Developer Guide

    Details

      Description

      Investigation supporting RFC-225 revealed that some rules in the Confluence documentation guidelines (e.g., the use of @ for Doxygen tags, or placing all documentation at the point of declaration) are not present in the developer guide. Ensure all relevant rules are present in the final documentation (senior developers have the final word on which rules are relevant).

        Attachments

          Issue Links

            Activity

            Hide
            krzys Krzysztof Findeisen added a comment -

            K-T will have to approve any changes to the dev guide, regardless. An RFC might be appropriate, but it would be kind of weird given that this issue is already an implementation ticket for another RFC.

            Show
            krzys Krzysztof Findeisen added a comment - K-T will have to approve any changes to the dev guide, regardless. An RFC might be appropriate, but it would be kind of weird given that this issue is already an implementation ticket for another RFC.
            Hide
            tjenness Tim Jenness added a comment -

            You are stuck in a maze of twisty RFCs...

            K-T will have to approve the dev guide pull request before it can be merged anyhow.

            Show
            tjenness Tim Jenness added a comment - You are stuck in a maze of twisty RFCs... K-T will have to approve the dev guide pull request before it can be merged anyhow.
            Hide
            krzys Krzysztof Findeisen added a comment -

            Hi Kian-Tat Lim, could you please review DM-7892 and DM-9966? These are the final changes to the dev guide needed to close RFC-225 and RFC-307, and they're fairly small updates.

            Show
            krzys Krzysztof Findeisen added a comment - Hi Kian-Tat Lim , could you please review DM-7892 and DM-9966 ? These are the final changes to the dev guide needed to close RFC-225 and RFC-307 , and they're fairly small updates.
            Hide
            ktl Kian-Tat Lim added a comment -

            I think the one change affecting existing practice is the @code -> indent change. Please make sure to publicize this.

            Show
            ktl Kian-Tat Lim added a comment - I think the one change affecting existing practice is the @code -> indent change. Please make sure to publicize this.
            Hide
            krzys Krzysztof Findeisen added a comment -

            Merged and announced.

            Show
            krzys Krzysztof Findeisen added a comment - Merged and announced.

              People

              • Assignee:
                krzys Krzysztof Findeisen
                Reporter:
                krzys Krzysztof Findeisen
                Reviewers:
                Kian-Tat Lim
                Watchers:
                John Swinbank, Kian-Tat Lim, Krzysztof Findeisen, Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel