Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
http://api.drupal.org/api/function/user_pass_reset_url/7
has no function header docs at all.
Comment | File | Size | Author |
---|---|---|---|
#17 | doc-user_pass_reset_url-712598-d6.patch | 918 bytes | andypost |
#7 | doc-user_pass_reset_url-712598-7.patch | 954 bytes | add1sun |
#6 | doc-user_pass_reset_url-712598-6.patch | 1.17 KB | add1sun |
#5 | doc-user_pass_reset_url-712598-3.patch | 895 bytes | add1sun |
#2 | doc-user_pass_reset_url-712598-2.patch | 779 bytes | add1sun |
Comments
Comment #1
jhodgdonGracious! That function has been undocumented for several Drupal versions. Once it's fixed in D7, please also port fix to D6.
Comment #2
add1sun CreditAttribution: add1sun commentedPatch attached.
Comment #3
jhodgdonNeeds @param and @return... add1sun is repatching.
Comment #4
jhodgdonComment #5
add1sun CreditAttribution: add1sun commentedOk, trying again. Not sure my @return is descriptive enough....
Comment #6
add1sun CreditAttribution: add1sun commentedWill eventually sort this out. :-P
Comment #7
add1sun CreditAttribution: add1sun commentedHehe.
Comment #8
jhodgdonExcellent, I like #7. :)
Comment #9
jhodgdonAssuming the test bot says OK, of course.
Comment #10
webchickAwesome! Yay for fixing 40-year old bugs! Committed to HEAD. :)
Seems to apply to 6.x too, with a little fuzz.
Comment #11
jhodgdonI don't think webchick actually applied it to Drupal 6?
Comment #12
webchickLOL. Thanks. :) Yes, that's what I meant.
Comment #13
Gábor HojtsyUnless I'm misinformed, our API documentation guidelines do not let types to be specified inbetween @param and the variable name, do they?
Comment #14
jhodgdonNew guidelines are in place: Yes they do. It's standard in PHPDoc, and Drupal has adopted that standard.
http://drupal.org/node/1354#functions
Comment #15
Gábor HojtsyOk, where was this applied to D6? I've looked at a few functions and could not find this pattern being used.
Comment #16
jhodgdonIt's a brand new standard. I'm not aware of it being used anywhere in D6, and there are probably only 3 or 4 places that now have it in D7, because only a few patches have been applied to D7 with @return or @param types. I don't think we're planning any wholesale effort to go back and put them in everywhere, just adding them incrementally as we update doc.
So, this is likely the first one that has come up for D6.
However, it's all over PHP doc in general, on php.net etc. It is an industry standard, in other words, and the general idea is to add clarity to documentation of functions...
Comment #17
andypostAnyway here's a patch against current D6
Comment #18
jhodgdonThanks for the reroll. Definitely looks the same as the D7 patch, aside from the context.
Comment #19
Gábor HojtsyOk, committed.