Moodle
  1. Moodle
  2. MDL-31739

forum_get_email_message_id() is missing a doc block

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.3
    • Fix Version/s: 2.3
    • Component/s: Forum
    • Labels:

      Description

      forum_get_email_message_id() needs documenting. note that it only exists in master.

        Gliffy Diagrams

          Issue Links

            Activity

            Andrew Davis created issue -
            Andrew Davis made changes -
            Field Original Value New Value
            Assignee moodle.com [ moodle.com ] Andrew Davis [ andyjdavis ]
            Andrew Davis made changes -
            Link This issue discovered while testing MDL-30698 [ MDL-30698 ]
            Andrew Davis made changes -
            Fix Version/s STABLE Sprint 18 [ 11650 ]
            Michael de Raadt made changes -
            Labels triaged
            Hide
            Andrew Davis added a comment -

            Something like...

            /**
             * Create a message-id string to use in forum notification email custom headers
             * 
             * message-id is used by email clients to identify emails and to nest conversations
             *
             * @param int $postid The ID of the forum post we are notifying the user about
             * @param int $usertoid The ID of the user being notified
             * @param string $hostname The server's hostname
             * @return string A unique message-id
             */
            forum_get_email_message_id($postid, $usertoid, $hostname)
            

            Show
            Andrew Davis added a comment - Something like... /** * Create a message-id string to use in forum notification email custom headers * * message-id is used by email clients to identify emails and to nest conversations * * @param int $postid The ID of the forum post we are notifying the user about * @param int $usertoid The ID of the user being notified * @param string $hostname The server's hostname * @return string A unique message-id */ forum_get_email_message_id($postid, $usertoid, $hostname)
            Andrew Davis made changes -
            Status Open [ 1 ] Development in progress [ 3 ]
            Hide
            Andrew Davis added a comment -

            Adding a branch. This fix is master only.

            Show
            Andrew Davis added a comment - Adding a branch. This fix is master only.
            Andrew Davis made changes -
            Pull Master Diff URL https://github.com/andyjdavis/moodle/compare/master...MDL-31739_forum_docblock
            Pull Master Branch https://github.com/andyjdavis/moodle/compare/master...MDL-31739_forum_docblock
            Testing Instructions Just check that the doc block is present in /mod/forum/lib.php.
            Pull from Repository git://github.com/andyjdavis/moodle.git
            Andrew Davis made changes -
            Status Development in progress [ 3 ] Waiting for peer review [ 10012 ]
            Andrew Davis made changes -
            Gerard Caulfield made changes -
            Original Estimate 0 minutes [ 0 ]
            Remaining Estimate 0 minutes [ 0 ]
            Status Waiting for peer review [ 10012 ] Peer review in progress [ 10013 ]
            Peer reviewer gerry
            Hide
            Gerard Caulfield added a comment -

            Line 370 has a trailing space.

            "Create a message-id string to use in forum notification email custom headers" may be a little difficult to interpret due to the "forum notification email custom headers" phrase running together.
            You may wish to split it up like so:
            "Create a message-id string to use in the custom headers of forum notification emails."
            ...or something along those lines. Up to you though. Good fix.

            Show
            Gerard Caulfield added a comment - Line 370 has a trailing space. "Create a message-id string to use in forum notification email custom headers" may be a little difficult to interpret due to the "forum notification email custom headers" phrase running together. You may wish to split it up like so: "Create a message-id string to use in the custom headers of forum notification emails." ...or something along those lines. Up to you though. Good fix.
            Gerard Caulfield made changes -
            Status Peer review in progress [ 10013 ] Development in progress [ 3 ]
            Hide
            Andrew Davis added a comment -

            Removed the trailing space and went with your suggested reworking. Submitting for integration.

            Show
            Andrew Davis added a comment - Removed the trailing space and went with your suggested reworking. Submitting for integration.
            Andrew Davis made changes -
            Status Development in progress [ 3 ] Waiting for integration review [ 10010 ]
            Aparup Banerjee made changes -
            Status Waiting for integration review [ 10010 ] Integration review in progress [ 10004 ]
            Integrator nebgor
            Hide
            Aparup Banerjee added a comment -

            This looks good to integrate in coming cycle.

            Show
            Aparup Banerjee added a comment - This looks good to integrate in coming cycle.
            Aparup Banerjee made changes -
            Status Integration review in progress [ 10004 ] Waiting for integration review [ 10010 ]
            Aparup Banerjee made changes -
            Status Waiting for integration review [ 10010 ] Integration review in progress [ 10004 ]
            Currently in integration Yes [ 10041 ]
            Hide
            Aparup Banerjee added a comment -

            integrated and passing.

            Show
            Aparup Banerjee added a comment - integrated and passing.
            Aparup Banerjee made changes -
            Status Integration review in progress [ 10004 ] Waiting for testing [ 10005 ]
            Fix Version/s 2.3 [ 10657 ]
            Hide
            Aparup Banerjee added a comment -

            passing this non-code change.

            Show
            Aparup Banerjee added a comment - passing this non-code change.
            Aparup Banerjee made changes -
            Status Waiting for testing [ 10005 ] Testing in progress [ 10011 ]
            Tester nebgor
            Aparup Banerjee made changes -
            Status Testing in progress [ 10011 ] Tested [ 10006 ]
            Hide
            Eloy Lafuente (stronk7) added a comment -

            Well,

            I wish I said it every time
            you do the things you do.
            You always lend a helping hand,
            and I'm filled with gratitude.

            You are strong and generous
            for each and everyone one of us.
            I am eternally grateful,
            I cannot say thanks enough.

            Sorry for the (un)cool bit above, lol. Closing this as fixed. Ciao

            Show
            Eloy Lafuente (stronk7) added a comment - Well, I wish I said it every time you do the things you do. You always lend a helping hand, and I'm filled with gratitude. You are strong and generous for each and everyone one of us. I am eternally grateful, I cannot say thanks enough. Sorry for the (un)cool bit above, lol. Closing this as fixed. Ciao
            Eloy Lafuente (stronk7) made changes -
            Status Tested [ 10006 ] Closed [ 6 ]
            Resolution Fixed [ 1 ]
            Currently in integration Yes [ 10041 ]
            Integration date 01/Mar/12
            Eloy Lafuente (stronk7) made changes -
            Fix Version/s STABLE Sprint 18 [ 11650 ]

              People

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

                Dates

                • Created:
                  Updated:
                  Resolved: