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

Boostrap less code must be documented

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Medium
    • Coding style
    • None

    Description

      We know from other places (that is PHPdoc and JSdoc comments on our functions and methods) that if you want people to consistently re-use standard code, then it is good if the chunks you expect people to reuse can be documented, and that documentation works best when it is in the code right next to the thing being documented.

      Unfortunately, it seems that the LESS community does not yet have a standard convention for documenting individual chunks of code that you expect people to reuse in a standard way.

      I think we should define our own convention for documenting these things, hence I am creating this coding style issue.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              timhunt Tim Hunt
              Votes:
              1 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:

                Clockify

                  Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.