User action "block user" docblock correction

This is a simple fix and its good to go

Please don't invent tags. See tag guidelines link under the tags field.

Regarding this patch... I don't think that it really captures what is happening to choose which user is blocked. I agree that the current docs are wrong, but this change doesn't quite fix the docs. Really it needs @param docs, and a paragraph that explains what is happening.

Please dont be so quick to assume that everyone knows what is the "correct" tag to choose ... its is becoming harder and harder to know what is what on D.O. even for folks who are in the issue queue all the time. This tag has been there for a long time now.

That's why we have the tag guidelines (link below the tags field). :)

Working at code sprint.

Here's a shot at a revision.

Please read
http://drupal.org/node/1354#drupal
(2nd to last bullet point about the first line of any documentation block being a summary)

Apologies on that one, updated patch enclosed.

#13: 1683794_block-user-action_13.patch queued for re-testing.

#13: 1683794_block-user-action_13.patch found correct except few grammatical mistakes. Good to go after correcting them.

Corrected them in the attachment.

resubmitted patch.

resubmitted patch with unix style line ending.

Thanks for helping out, @meetme. Looks like your last patch may have gone awry.

resubmitted a patch.

patch resubmit

Thanks for the patch!

It needs a bit of work...

First, "uid" is not an English word. So, in documentation we need to write "user ID" instead. And in some cases, maybe it is better to say something like "the user to block" or "the ID of the user to block".

Also, when referring to elements of an associative array, use the word "element" not "property".

Finally... I'm not in love with all of the (optional) (optionally) bits. How about making some better wording? For instance, maybe something like this for $entity:

(optional) An entity object; if it is provided and it has a uid property, the user with that ID is blocked.

If we made the $context parameter also better and added something like "If no user ID was found from $entity" in it somewhere, then we could eliminate the other text (which would then be redundant), and people would have less to read to figure out what the function does.

This issue may no longer be relevant. The logic for this call has been moved into Plugin/Action/BlockUser and is likely documented appropriately there.

With that said, I'm not 100% sure that the Plugin Action couldn't benefit from additional documentation, so just trying to bubble this up to someone who feels comfortable closing it if that's the right thing to do. :)

I don't see any major problems with the documentation of the BlockUser plugin class, so let's just move this issue to D7, where it still needs a new patch to address the most recent review.

26: 1683794_block-user-action_26.patch queued for re-testing.

The patch in #26 needs to be rerolled for Drupal 7, and the review comments in #28 still need to be addressed. Thanks!

Attached :).

Thanks! This is exactly right. I'll get it committed shortly.

Thanks again everyone! Committed to 7.x.