actions_save function has undocumented type option [#392688]

The definition of actions_save is:

function actions_save($function, $type, $params, $desc, $aid = NULL) {

Yet the documentation says:

Parameters

$function The name of the function to be called when this action is performed.

$params An associative array with parameter names as keys and parameter values as values.

$desc A user-supplied description of this particular action, e.g., 'Send e-mail to Jim'.

$aid The ID of this action. If omitted, a new action is created.

http://api.drupal.org/api/function/actions_synchronize/6

Comment	File	Size	Author
#11	392688-D6.patch	683 bytes	jhodgdon
#11
#5	392688-actions_save_type_param_doc.diff	673 bytes	jeffschuler
#5
#2	392688-actions_save_type_param_doc.diff	673 bytes	jeffschuler
#2

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

jeffschuler

Boulder, Colorado

CreditAttribution: jeffschuler commented 7 March 2009 at 15:26

Assigned:

Unassigned

» jeffschuler

Comment #2

jeffschuler

Boulder, Colorado

CreditAttribution: jeffschuler commented 11 March 2009 at 05:11

Status:

Needs work

» Needs review

File	Size
392688-actions_save_type_param_doc.diff	673 bytes

Patch to add $type param to documentation for actions_save() -- using (paraphrased) description of type from actions_list().

Comment #3

JuliaKM CreditAttribution: JuliaKM commented 7 March 2009 at 17:38

Assigned:	jeffschuler	» Unassigned
Status:	Active	» Reviewed & tested by the community

The new piece of documentation is correct. The action_save function appears to be documented correctly.

Comment #4

9 March 2009 at 16:50

Status:

Reviewed & tested by the community

» Needs work

The last submitted patch failed testing.

Comment #5

jeffschuler

Boulder, Colorado

CreditAttribution: jeffschuler commented 11 March 2009 at 05:23

File	Size
392688-actions_save_type_param_doc.diff	673 bytes

Resubmitting same -- pretty sure a patch of comments didn't break install.

Comment #6

cburschka

they

CreditAttribution: cburschka commented 28 April 2009 at 12:25

Status:

Needs review

» Reviewed & tested by the community

Can't find any issue with the code-style or English of this comment, so this is probably ready.

Comment #7

1 May 2009 at 11:15

Status:

Reviewed & tested by the community

» Needs work

The last submitted patch failed testing.

Comment #8

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 17 June 2009 at 18:02

Status:

Needs work

» Reviewed & tested by the community

The patch applies fine for me, and looks good to me. There must have been a glitch in the testing system. I think it should be applied.

Note that the link to api.drupal.org is to the wrong function in the original issue. The function patched is http://api.drupal.org/api/function/actions_save/6

The patch above is for D7. After it is applied, it should be ported to D6 (slightly different context, so the above patch does not apply in D6).