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

forum_get_email_message_id() is missing a doc block

    Details

    • Type: Bug
    • Status: Closed
    • Priority: 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

          Attachments

            Issue Links

              Activity

              Hide
              andyjdavis 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
              andyjdavis 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)
              Hide
              andyjdavis Andrew Davis added a comment -

              Adding a branch. This fix is master only.

              Show
              andyjdavis Andrew Davis added a comment - Adding a branch. This fix is master only.
              Hide
              gerry 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
              gerry 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.
              Hide
              andyjdavis Andrew Davis added a comment -

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

              Show
              andyjdavis Andrew Davis added a comment - Removed the trailing space and went with your suggested reworking. Submitting for integration.
              Hide
              nebgor Aparup Banerjee added a comment -

              This looks good to integrate in coming cycle.

              Show
              nebgor Aparup Banerjee added a comment - This looks good to integrate in coming cycle.
              Hide
              nebgor Aparup Banerjee added a comment -

              integrated and passing.

              Show
              nebgor Aparup Banerjee added a comment - integrated and passing.
              Hide
              nebgor Aparup Banerjee added a comment -

              passing this non-code change.

              Show
              nebgor Aparup Banerjee added a comment - passing this non-code change.
              Hide
              stronk7 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
              stronk7 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

                People

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

                  Dates

                  • Created:
                    Updated:
                    Resolved:
                    Fix Release Date:
                    25/Jun/12