Moodle
  1. Moodle
  2. MDL-30990

rating API, check and update DocBlock

    Details

    • Type: Task Task
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.2, 2.2.1
    • Fix Version/s: 2.3
    • Component/s: Documentation, Ratings
    • Labels:
    • Rank:
      37394

      Description

      Check and update documentation, so that it should comply with moodle coding guidelines.
      Following needs to be updated/checked for rating api

      1. DocBlock for page and functions.
      2. All the files should be checked/updated.

      Note: You can create sub-tasks, so as to avoid bulk integration.

      1. smurf.xml
        6 kB
        Eloy Lafuente (stronk7)

        Activity

        Hide
        Martin Dougiamas added a comment -

        Any progress on this yet?

        Show
        Martin Dougiamas added a comment - Any progress on this yet?
        Hide
        Jason Fowler added a comment -

        Not yet, I've been working through the RSS API

        Show
        Jason Fowler added a comment - Not yet, I've been working through the RSS API
        Hide
        Jason Fowler added a comment -

        Please ignore the branch name, the MDL in it's description is correct though

        Show
        Jason Fowler added a comment - Please ignore the branch name, the MDL in it's description is correct though
        Hide
        Martin Dougiamas added a comment -

        Docs still need a lot of work. This shouldn't be very hard. http://docs.moodle.org/dev/Rating_API

        Show
        Martin Dougiamas added a comment - Docs still need a lot of work. This shouldn't be very hard. http://docs.moodle.org/dev/Rating_API
        Hide
        Jason Fowler added a comment -

        Just ran it through Marina's script to make sure I didn't miss anything

        Show
        Jason Fowler added a comment - Just ran it through Marina's script to make sure I didn't miss anything
        Hide
        Jason Fowler added a comment -

        Will get back to the wiki docs after I have finished my work on Sprint 17

        Show
        Jason Fowler added a comment - Will get back to the wiki docs after I have finished my work on Sprint 17
        Hide
        Michael de Raadt added a comment -

        Some comments:

        rating/lib.php

        • Line 324, some unnecessary whitespace in this parameter
        • Line 733, TODO should be @todo and should have an MDL included
        • Line 738, type should be int|null
        • Line 754, needs a blank comment line after description
        • Lines 762, 764, 767, some unnecessary blank lines, also, this comment is a bit inconsistent with previous class parameters and needs a closing brace, not that that's standard or anything
        • Line 891, needs a blank comment line after description
        • Line 920, needs a blank comment line after description
        • Line 931, needs a blank comment line after description
        • Line 1056, needs a blank comment line after description
        Show
        Michael de Raadt added a comment - Some comments: rating/lib.php Line 324, some unnecessary whitespace in this parameter Line 733, TODO should be @todo and should have an MDL included Line 738, type should be int|null Line 754, needs a blank comment line after description Lines 762, 764, 767, some unnecessary blank lines, also, this comment is a bit inconsistent with previous class parameters and needs a closing brace, not that that's standard or anything Line 891, needs a blank comment line after description Line 920, needs a blank comment line after description Line 931, needs a blank comment line after description Line 1056, needs a blank comment line after description
        Hide
        Jason Fowler added a comment -

        Thanks for the feedback Michael, those changes have now been made.

        Show
        Jason Fowler added a comment - Thanks for the feedback Michael, those changes have now been made.
        Hide
        Eloy Lafuente (stronk7) added a comment -

        Hi Jason, attaching another xml file, it shows the incorrect "asterisks" and some incorrect tabs/whitespace. I think you can ignore safely the rest.

        Ciao

        Show
        Eloy Lafuente (stronk7) added a comment - Hi Jason, attaching another xml file, it shows the incorrect "asterisks" and some incorrect tabs/whitespace. I think you can ignore safely the rest. Ciao
        Hide
        Jason Fowler added a comment -

        Thanks for that Eloy, all cleaned up now.

        Show
        Jason Fowler added a comment - Thanks for that Eloy, all cleaned up now.
        Hide
        Andrew Davis added a comment -

        I believe the wiki docs are done. http://docs.moodle.org/dev/Rating_API

        Jason, feel free to reshuffle it and add anything I missed. Just make sure that to limit it to stuff someone adding ratings support to a custom activity module would be interested in. There were a few references to rating.php and rating_ajax.php which are internal files that someone using ratings doesn't need to be bothered with.

        Show
        Andrew Davis added a comment - I believe the wiki docs are done. http://docs.moodle.org/dev/Rating_API Jason, feel free to reshuffle it and add anything I missed. Just make sure that to limit it to stuff someone adding ratings support to a custom activity module would be interested in. There were a few references to rating.php and rating_ajax.php which are internal files that someone using ratings doesn't need to be bothered with.
        Hide
        Eloy Lafuente (stronk7) added a comment -

        Sorry, Jason... but where are the changes? I continue getting the same errors about bad asterisks and tabs/whitespace. Perhaps the work is into another branch? Note that the one above (wip-MDL-30991-master) doesn't match this issue number (MDL-30990).

        Holding this....ciao

        Show
        Eloy Lafuente (stronk7) added a comment - Sorry, Jason... but where are the changes? I continue getting the same errors about bad asterisks and tabs/whitespace. Perhaps the work is into another branch? Note that the one above (wip- MDL-30991 -master) doesn't match this issue number ( MDL-30990 ). Holding this....ciao
        Hide
        Eloy Lafuente (stronk7) added a comment -

        Ping!

        Show
        Eloy Lafuente (stronk7) added a comment - Ping!
        Hide
        Rajesh Taneja added a comment -

        Hello Eloy,
        Jason is on leave and will be back next month

        Show
        Rajesh Taneja added a comment - Hello Eloy, Jason is on leave and will be back next month
        Hide
        Eloy Lafuente (stronk7) added a comment - - edited

        I'm reopening this for Jason to take a look to it after he returns. Surely he will need to rebase (apart from fixes) as far as the branch has been on hold for many weeks.

        TIA!

        Show
        Eloy Lafuente (stronk7) added a comment - - edited I'm reopening this for Jason to take a look to it after he returns. Surely he will need to rebase (apart from fixes) as far as the branch has been on hold for many weeks. TIA!
        Hide
        Jason Fowler added a comment -

        All there now, I don't know why I forgot to push the changes ...

        Show
        Jason Fowler added a comment - All there now, I don't know why I forgot to push the changes ...
        Hide
        Eloy Lafuente (stronk7) added a comment -

        The main moodle.git repository has just been updated with latest weekly modifications. You may wish to rebase your PULL branches to simplify history and avoid any possible merge conflicts. This would also make integrator's life easier next week.

        TIA and ciao

        Show
        Eloy Lafuente (stronk7) added a comment - The main moodle.git repository has just been updated with latest weekly modifications. You may wish to rebase your PULL branches to simplify history and avoid any possible merge conflicts. This would also make integrator's life easier next week. TIA and ciao
        Hide
        Jason Fowler added a comment -

        All rebased and ready for the integrators to work their magic

        Show
        Jason Fowler added a comment - All rebased and ready for the integrators to work their magic
        Hide
        Eloy Lafuente (stronk7) added a comment -

        Integrated, thanks!

        Show
        Eloy Lafuente (stronk7) added a comment - Integrated, thanks!
        Hide
        Eloy Lafuente (stronk7) added a comment -

        Nobody tested this, passing!

        Show
        Eloy Lafuente (stronk7) added a comment - Nobody tested this, passing!
        Hide
        Eloy Lafuente (stronk7) added a comment -

        Your changes are now upstream and will be included in the next minor released scheduled for March 13th (next Monday!).

        icao_reverse('arreis olik rebemevon afla letoh ognat');
        

        Closing, ciao

        Show
        Eloy Lafuente (stronk7) added a comment - Your changes are now upstream and will be included in the next minor released scheduled for March 13th (next Monday!). icao_reverse('arreis olik rebemevon afla letoh ognat'); Closing, ciao

          People

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

            Dates

            • Created:
              Updated:
              Resolved: