Early Bird Registration for DrupalCon Portland 2024 is open! Register by 23:59 PST on 31 March 2024, to get $100 off your ticket.
On user_load(), the parameters documentation reports the function accepts an array, but it doesn't report the function also accept a user ID.
Comment | File | Size | Author |
---|---|---|---|
#11 | 872374_4.patch | 1.67 KB | sender |
#9 | 872374_3.patch | 1.66 KB | sender |
#8 | 872374_2.patch | 1.55 KB | sender |
#3 | 872374.patch | 633 bytes | sender |
Comments
Comment #1
jhodgdonThat's true - and it's a Drupal 6 issue only. Thanks for the report.
This is a good project for a novice Drupal contributor...
Comment #2
sender CreditAttribution: sender commentedComment #3
sender CreditAttribution: sender commentedHere's a small patch.
Comment #4
sender CreditAttribution: sender commentedComment #5
jhodgdonThat looks good, thanks!
Comment #6
Gábor HojtsyIs it still good then to name the argument $array?
Comment #7
jhodgdonWell, that's a good point. I agree, we should change the argument name to something else besides $array. Perhaps $info or $attributes? That would still constitute a doc patch, as long as only the argument name is changed.
Comment #8
sender CreditAttribution: sender commentedGood point indeed. Here's a new version with a search and replace on $array with $user_info. Credits for the name: jhodgdon ;)
Comment #9
sender CreditAttribution: sender commentedImproved with better wording and a list describing the different possibilities on how to use $user_info.
Comment #10
jhodgdonOne of the documentation lines needs to be wrapped at 80 characters.
Otherwise it looks OK.
Comment #11
sender CreditAttribution: sender commentedFixed.
Comment #14
apadernoShould not the phrase changed with a different one?
Comment #15
jhodgdonWhat's wrong with that phrase?
I'm ready to mark #13 as RTBC, but not until I hear what kiamlaluno has to say about why that line needs changing. :)
Comment #16
apadernoWhat I read is not a sentence. I would rather remove that line, as the following comment lines describe already what the argument is.
Comment #17
sender CreditAttribution: sender commented@kiamlaluno: tried that before, but would that be valid Doxygen? If the line is needed, what do you suggest that would be a sentence in your view?
@jhodgdon: is this line really necessary? Can't find anything about it at https://drupal.org/node/1354#lists (or I might be blind).
Comment #18
jhodgdonTypically we don't just put a list in without a line (ending in :) right before it, explaining what the list means. In this case, I think the line needs to explain that it's either/or. You could shorten it to "One of these alternatives:" or something like that.
Comment #20
apadernoComment #22
jhodgdonThe D6 test bot is choking on every patch. This patch is still fine.
Comment #23
Gábor HojtsyThanks, committed.