Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-22191

Codesniffer does not respect coding style guidelines re function comments

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Not a bug
    • Icon: Minor Minor
    • None
    • 2.0
    • Other
    • None
    • MOODLE_20_STABLE

      I added a docblock like this:

      • Creates a object containing all evidence pertaining to the portfolio with the given id
        *
      • @param string $url the url of the web site that will be downloaded
      • @param string $savedir the name of the directory to save the retrieved site in

      (extra spaces after 'string' on both lines so that all the $ signs line up - there are a load more parameters)

      and got an error like this:

      44 | WARNING | The comments for parameters $url (1) and $savedir (2) do not

        align

      Which conflicts with advice here where the $ signs line up: http://docs.moodle.org/en/Development:Coding_style#Functions

            stronk7 Eloy Lafuente (stronk7)
            mattgibson Matt Gibson (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:

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