Closed (fixed)
Project:
Drupal core
Version:
7.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Reporter:
Created:
21 Feb 2010 at 15:21 UTC
Updated:
3 Dec 2015 at 22:22 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonThat is true, good catch! It looks like only the comment module actions are listed on http://api.drupal.org/api/group/actions/7
Also, the doxygen for the defgroup there is lame and shouldn't be telling people how to add @ingroup, but instead describing what the group is.
Comment #2
jhodgdonHere's a patch...
Comment #3
willmoy commentedNitpick: "Action function: ..."
Nearest thing to a standard seems to be "Action to..."
http://api.drupal.org/api/search/7/_action
Whether or not that matters, I think "Action: ..." would suffice.
Double space here in system_goto_action()
"+ * - 'url': URL to redirect to. This will be passed through"
Even bigger nckpick: technically, a colon is not followed by a capital letter.
Really sound and worthwhile patch, other than those tiny things. Could happily see it committed as is.
Comment #4
jhodgdonOK.
Comment #5
jhodgdonRegarding:
Double space here in system_goto_action()
"+ * - 'url': URL to redirect to. This will be passed through"
That is intentional. It's part of a bullet list.
Regarding all of the "Action function:" things... I don't know what I was thinking. :) I removed all of them. All of the functions are marked "@ingroup actions" and that should be good enough.
Anyway, here's a new patch.
Comment #6
jhodgdonComment #7
willmoy commentedNice, thanks. I'm fine with this but will leave to someone else to RTBC.
@jhodgdon The two spaces I was referring to weren't around the bullet list, they were those in the middle of "redirect to. This will be" don't know if that was clear.
Comment #8
jhodgdonAh! No, I missed those. Dang.
Do you know why I do that from time to time? Because I learned to type on a typewriter, and back then, we were always told to put two spaces after the end of a sentence. It's a hard habit to break when it costs you points on your work in 8th grade (and there wasn't any easy way to backspace and fix things back then either).
Yes, I'm almost as old as the dinosaurs. :)
Anyway, here's the last patch with the double space removed. Thanks!
Comment #9
jhodgdonAs wilmoy is happy with it and so am I, I'll tentatively mark as RTBC. Doc cleanup only anyway...
Comment #10
willmoy commentedTotally reasonable, I agree.
Comment #11
dries commentedMore documentation goodies. Committed to CVS HEAD. Thanks.
Comment #12
jhodgdonA 6.x port of this might be useful...
Comment #13
albert volkman commentedD6 backport.
Comment #14
albert volkman commentedAlso, here's a small patch for the documentation project that was included in the upstream version. Not sure if I should put it here or create a new issue.
Comment #15
jhodgdonThanks!
RE patch in #14 - that is fine, I can commit it from here to the docs project.
RE patch in #13, it looks good except this one line:
Comment #16
jhodgdonThat #14 patch has been committed to the docs repository.
Comment #17
albert volkman commentedThanks!
Comment #18
jhodgdonUh oh, one more thing:
@param $entity, but the actual param name is $object here. Also I don't think we're generally putting param/return types in for Drupal 6?
The same is true for the next few functions in the patch.
I didn't yet check the array elements in $context for these functions either.
Comment #19
albert volkman commentedThe array elements for context are hook, node, comment, account, and recipient.
$object is a node object I believe (if it hasn't been passed through $context['node']).
I'm not hot at writing documentation, so whatever wording makes sense for each of those items.
Comment #20
jhodgdonOh, your documentation is clear. I just meant I hadn't checked it against the function code itself (kind of a busy day). That was a reminder to myself for the full review that I need to check that in order to give the documentation a thorough review. Sometimes things change between Drupal versions...
Comment #21
jhodgdonI am cleaning up old 6.x documentation issues. At this point, we are not spending effort fixing them. Sorry.
This one started as D7 and was fixed, so setting back to taht.