API page: http://api.drupal.org/api/drupal/modules--user--user.module/function/_us...

Describe the problem you have found:

The list of possible values for the argument $op is really hardly readable, please make a

  • list out of it.
    Thank you!
    • CommentFileSizeAuthor
    #12 user-indentation-1416212-12.patch1.97 KBpontus_nilsson
    #10 user-indentation-1416212-9.patch1.97 KBpontus_nilsson
    #6 user-indentation-1416212-6.patch2.12 KBpontus_nilsson
    #4 user-indentation-1416212-4.patch2.1 KBpontus_nilsson
    #2 user-indentation-1416212-2.patch2.09 KBpontus_nilsson
    Support from Acquia helps fund testing for Drupal Acquia logo

    Comments

    jhodgdon’s picture

    jhodgdon
    she/her
    Primary language English
    CreditAttribution: jhodgdon commented
    Title: Documentation problem with _user_mail_notify » _user_mail_notify -- options for $op need to be a list
    Version: 6.x-dev » 8.x-dev
    Issue tags: +Needs backport to D6, +Novice, +Needs backport to D7

    Thanks for reporting this! Good novice project, and needs to be done in Drupal 8, then 7, then 6.

    pontus_nilsson’s picture

    pontus_nilsson
    Location Stockholm
    CreditAttribution: pontus_nilsson commented
    Status: Active » Needs review
    FileSize
    user-indentation-1416212-2.patch2.09 KB

    Patch adds correct indentation and "-" for the possible values for function _user_mail_notify() description. Patch is against 8.x

    jhodgdon’s picture

    jhodgdon
    she/her
    Primary language English
    CreditAttribution: jhodgdon commented
    Status: Needs review » Needs work

    Looks close, thanks!

    Please check out our list guidelines though -- every list item should end with a . :
    http://drupal.org/node/1354#lists
    You might also verify that none of those lines exceeds 80 characters, just in case.

    Also, we need a blank line between @param and @return.

    Thanks for catching and fixing the indentation on the param/returns too!

    pontus_nilsson’s picture

    pontus_nilsson
    Location Stockholm
    CreditAttribution: pontus_nilsson commented
    FileSize
    user-indentation-1416212-4.patch2.1 KB

    Thank you for your guideance.
    New patch adds "." to end of list items and a blank line between @param and @return.
    Regarding line lengths, does this count as 80 or 81?

     *   - 'register_no_approval_required': Welcome message when user self-registers.
    pontus_nilsson’s picture

    pontus_nilsson
    Location Stockholm
    CreditAttribution: pontus_nilsson commented
    Status: Needs work » Needs review
    pontus_nilsson’s picture

    pontus_nilsson
    Location Stockholm
    CreditAttribution: pontus_nilsson commented
    FileSize
    user-indentation-1416212-6.patch2.12 KB

    New patch ensures line length of 80 characters.

    jhodgdon’s picture

    jhodgdon
    she/her
    Primary language English
    CreditAttribution: jhodgdon commented
    Status: Needs review » Reviewed & tested by the community

    Looks good, thanks!

    webchick’s picture

    webchick
    she/they
    Primary language English
    Location Vancouver 🇨🇦
    CreditAttribution: webchick commented
    Status: Reviewed & tested by the community » Fixed

    Looks great!

    Committed and pushed to 8.x and 7.x. Thanks!

    jhodgdon’s picture

    jhodgdon
    she/her
    Primary language English
    CreditAttribution: jhodgdon commented
    Version: 8.x-dev » 6.x-dev
    Status: Fixed » Patch (to be ported)

    Still needs backport to D6.

    pontus_nilsson’s picture

    pontus_nilsson
    Location Stockholm
    CreditAttribution: pontus_nilsson commented
    Status: Patch (to be ported) » Needs review
    FileSize
    user-indentation-1416212-9.patch1.97 KB

    Attached patch is against 6.x branch. Changed the indentation, added "-" to seperate list items, added punctuation and blank row before return value.

    jhodgdon’s picture

    jhodgdon
    she/her
    Primary language English
    CreditAttribution: jhodgdon commented
    Status: Needs review » Needs work

    Thanks! It looks like there is one other mistake to correct in 6.x -- there are two spaces instead of one after the . in this line:

    + *   The user object of the account being notified.  Must contain at
    pontus_nilsson’s picture

    pontus_nilsson
    Location Stockholm
    CreditAttribution: pontus_nilsson commented
    Status: Needs work » Needs review
    FileSize
    user-indentation-1416212-12.patch1.97 KB

    New patch fixes the two spaces noticed in #11.

    jhodgdon’s picture

    jhodgdon
    she/her
    Primary language English
    CreditAttribution: jhodgdon commented
    Status: Needs review » Reviewed & tested by the community

    Looks good, thanks!

    Gábor Hojtsy’s picture

    Gábor Hojtsy
    he/him
    Primary language Hungarian
    Location Hungary
    CreditAttribution: Gábor Hojtsy commented
    Status: Reviewed & tested by the community » Fixed

    Thanks a lot, committed, pushed.

    Automatically closed -- issue fixed for 2 weeks with no activity.