Uploaded image for project: 'Moodle Community Sites'
  1. Moodle Community Sites
  2. MDLSITE-4789

Refine Inline_comments note about adding MDL-X to comments

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Component/s: Coding style
    • Labels:
      None

      Description

      During a review I commented that we tend to avoid adding MDL-xxxxx numbers to comments because otherwise we may end up with an MDL-123123 in each comment, the assignee pointed me to the following https://docs.moodle.org/dev/Coding_style#Inline_comments note:

      If your comment is due to some MDL issue, please feel free to include the correct MDL-12345 in your comment. This makes it easier to track down decisions and discussions about things.

      After discussing about the case in the integration chat we agreed that we should refine this sentence as we are not interested in encouraging people to add MDL-123123 everywhere, just when a long explanation is required or it is a really dodgy or controversial case.

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: