Closed (fixed)
Project:
Drupal core
Version:
6.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Issue tags:
Reporter:
Created:
25 May 2011 at 23:38 UTC
Updated:
4 Jan 2014 at 00:53 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonGood catch! The OOP is correct on what the values are. This is a D6 issue only (the function does not exist in D7/8). Probably a good project for a novice contributor.
Comment #2
barbi commentedComment #3
jhodgdonCould you please:
- reformat the @param section so it conforms with our doc standards
- format the choices as a list:
A status value to set the file to. One of:
- FILE_STATUS_PERMANENT
- FILE_STATUS_TEMPORARY
Comment #4
barbi commentedComment #5
jhodgdonStill not formatted correctly:
http://drupal.org/node/1354#functions
Should be more like:
* @param $mail
* A string containing an email address.
Needs:
- $ before the variable names
- @param $var on one line, description on next line
- Period at end of description
- Also, : before the list
Comment #6
charlie-s commentedComment #7
jhodgdonThat's better. Thanks! I guess we could also fix the verb at the top of the function to "Sets", but that's kind of a separate issue and anyway much of D6 doesn't follow that standard as it was adopted in D7.
Comment #8
gábor hojtsyThanks, committed.