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.
'and returns any validation errors encountered'
Function does not return any values. Might be referring to the values of the function being passed by reference.
Comment | File | Size | Author |
---|---|---|---|
#13 | drupal-execute-D6.patch | 1.22 KB | rdrh555 |
#11 | drupal-execute-D6.patch | 1.16 KB | rdrh555 |
#9 | drupal-execute-D6.patch | 21 KB | rdrh555 |
#3 | 727126.patch | 1.5 KB | jhodgdon |
Comments
Comment #1
jhodgdonhttp://api.drupal.org/api/function/drupal_execute/6
Good catch! The function does not return anything. The documentation also needs to be updated to conform with standards (one summary line at the beginning, followed by a blank line).
Actually, though, the Drupal 7 version is wrong too:
http://api.drupal.org/api/function/drupal_form_submit/7
We need to fix it in Drupal 7 first, then back-port to Drupal 6.
Comment #2
jhodgdonComment #3
jhodgdonHere's a patch that fixes up the doc for D7. Needs a port to D6 if accepted.
Comment #4
grendzy CreditAttribution: grendzy commentedlooks good.
Comment #5
Dries CreditAttribution: Dries commentedCommitted to CVS HEAD. Thanks.
Comment #6
jhodgdonComment #7
jhodgdonWhoever ports this doc fix: Make sure to remove the blank line between For example: and the @code in the @param section, because it's causing a problem:
#750170: Documentation problem with drupal_execute
(marked as duplicate of this issue, since the above D7 patch fixed the same issue in D7 docs).
Comment #8
jhodgdonHere's another report of the same problem:
#833910: Documentation problem with drupal_execute
Comment #9
rdrh555 CreditAttribution: rdrh555 commentedFixed drupal_execute() and entire file.
Should line 38 be removed? In all cases such as this?
37 * @endcode
38 *
39 * Forms can also be built and submitted programmatically without any user input
Best guess as to when author intends for text to immediately follow code?
From Doxygen directives - general notes: (shows documentation of a function example)
/**
* Summary here; one sentence on one line (should not, but can exceed 80 chars).
However, under Documenting functions and methods:
The first line of the block should contain a brief description of what the function does, limited to 80 characters.....
Could someone explain this fine distinction? Is it ever acceptable (>80 chars)?
Comment #10
jhodgdonRegarding the 80 character limit: It's a very strong suggestion, and whether it's a hard limit or not depends on who is reviewing your patch.... I have yet to see a function that cannot be summarized in one 80 character line.
And... While I applaud your efforts to standardize the documentation in form.inc, this really needs to be done in Drupal 7 before it is done in Drupal 6 -- we're trying to avoid regression, where Drupal 6 gets in better shape than Drupal 7, or has bugs fixed that Drupal 7 doesn't have fixed. So I think maybe the patch should be limited to what was in the committed patch in #3 above.
Comment #11
rdrh555 CreditAttribution: rdrh555 commentedComment #12
jhodgdonI think the language in #3 was a bit better than this D6 port?
Comment #13
rdrh555 CreditAttribution: rdrh555 commentedComment #14
jhodgdonThanks.
Comment #15
Gábor HojtsyThanks, committed.