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

Code documentation for new activity header page properties is non-existent

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: Minor Minor
    • 4.0
    • 4.0
    • Navigation
    • MOODLE_400_STABLE
    • MOODLE_400_STABLE
    • Hide

      Manual testing requires an IDE to confirm that you are informed of the various method/properties of the activity header API

      Confirm that the following are autocompleted/documented:

      • $PAGE->activityheader
      • $PAGE->activityheader->set_attrs()
      • $PAGE->theme->activityheaderconfig

      Automated tests will cover changes to set_attrs() method (debugging or otherwise)

      Show
      Manual testing requires an IDE to confirm that you are informed of the various method/properties of the activity header API Confirm that the following are autocompleted/documented: $PAGE->activityheader $PAGE->activityheader->set_attrs() $PAGE->theme->activityheaderconfig Automated tests will cover changes to set_attrs() method (debugging or otherwise)

      Trying to use the new activityheader collection of methods/properties within the $PAGE object is very difficult because there is no hinting and/or documentation to allow my IDE to provide autocomplete suggestions, documentation, or help regarding how to use it

      The only way to figure out how to use any of this API is to find existing examples (which supposes you already know what you're looking for...)

        1. MDL-74071_activity header.png
          43 kB
          Angelia Dela Cruz
        2. MDL-74071_activityheaderconfig.png
          54 kB
          Angelia Dela Cruz
        3. MDL-74071_set_attrs.png
          78 kB
          Angelia Dela Cruz

            pholden Paul Holden
            pholden Paul Holden
            Peter Dias Peter Dias
            Ilya Tregubov Ilya Tregubov
            Angelia Dela Cruz Angelia Dela Cruz
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved:

                Estimated:
                Original Estimate - 0 minutes
                0m
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 1 hour, 15 minutes
                1h 15m

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