API page: http://api.drupal.org/api/drupal/core%21includes%21form.inc/function/bat...

(also relevant for:
http://api.drupal.org/api/drupal/includes!form.inc/function/batch_set/7
http://api.drupal.org/api/drupal/includes!form.inc/function/batch_set/6
)

Describe the problem you have found:

Noticed some grammatical inconsistency and out-of-the-blue gendering of batch sets in the documentation for /6, /7 and /8:

"Each batch set gets to specify his own UI messages, operates on its own set of operations and results, and triggers its own 'finished' callback."

Proposed edit (change 'his' -> 'its' to match the rest of the sentence):

"Each batch set gets to specify its own UI messages, operates on its own set of operations and results, and triggers its own 'finished' callback."

Thanks!

Files: 
CommentFileSizeAuthor
#13 1436074_13.patch752 byteststoeckler
PASSED: [[SimpleTest]]: [MySQL] 190 pass(es).
[ View ]
#12 1436074_11_D7.patch752 bytesPat Redmond
#11 1436074_11_D7.patch752 bytesPat Redmond
#5 batch_set_1436074_5.patch778 bytesPat Redmond
PASSED: [[SimpleTest]]: [MySQL] 34,321 pass(es).
[ View ]

Comments

jhodgdon’s picture

Good catch!

Pat Redmond’s picture

How do I get access to update documentation? I have been trolling the Novice tasks, but I can't make the changes to fix this one...?

webchick’s picture

You would find this documentation in the core/includes/form.inc file, just above the function called "batch_set".

jhodgdon’s picture

Instructions on how to do this:
http://drupal.org/node/144223 (updating API docs)
http://drupal.org/novice (patching in general)
http://drupal.org/node/1424598 (new contributor task: make a patch for a Drupal core issue)
http://drupal.org/new-contributors#help (how to get help with all of this)

Pat Redmond’s picture

StatusFileSize
new778 bytes
PASSED: [[SimpleTest]]: [MySQL] 34,321 pass(es).
[ View ]

Ah, OK. So you don't edit the page itself. The page is created by the documentation in the file. That makes sense now I think about it.

Here is a D8 patch file. Let me know if there are any issues. If not, I will make a patch file for D7 and D6 too.

jhodgdon’s picture

Status:Active» Reviewed & tested by the community
Issue tags:+Quick fix

Looks good Pat, thanks!

The only thing you also need to do is, when attaching a patch, set the issue status to "Needs Review". This alerts both people and the automatic testing bot that there is a patch to review.

Then wait for it to be committed to 8.x (and possibly 7.x at the same time with the same patch), before porting the patch to 6.x (or 7.x if necessary).

Pat Redmond’s picture

OK, thanks for the info.

I see you've set it to 'reviewed and tested by the community'. I guess the next step is that it will be applied to D8? How do I know when that has happened? And how do I know if I need to do a D7 port, or if the same patch can be used for both?

tstoeckler’s picture

One of the committers will pick this up and say that he has committed this and then move it back to Drupal 7. So nothing to do for now, although that might take a few days/weeks sometimes.

Dries’s picture

Status:Reviewed & tested by the community» Fixed

Committed to 7.x and 8.x. Thanks!

jhodgdon’s picture

Version:8.x-dev» 6.x-dev
Status:Fixed» Patch (to be ported)

Still needs backport to D6.

Pat Redmond’s picture

Status:Patch (to be ported)» Needs review
StatusFileSize
new752 bytes

D6 patch

Pat Redmond’s picture

StatusFileSize
new752 bytes

D6 patch - even though it is named D7

tstoeckler’s picture

StatusFileSize
new752 bytes
PASSED: [[SimpleTest]]: [MySQL] 190 pass(es).
[ View ]

Uploading indentical (!) patch without D7 suffix so it can get a date with the bot.

tstoeckler’s picture

Status:Needs review» Reviewed & tested by the community

Also this is RTBC.
I did not change a single character in the patch, so I'm not marking my own patch RTBC.

Pat Redmond’s picture

What is RTBC?

Pat Redmond’s picture

Ready To Be Committed...
Do I need to mark it as RTBC?

tstoeckler’s picture

In theory RTBC means "Reviewed & Tested By the Community".
But, as you point it also means that this patch is in fact ready to be committed.
I put the issue status at "reviewed & tested by the community", so nothing left to do here. :)

xjm’s picture

I see this commit in D7, but not in D8.

jhodgdon’s picture

Version:6.x-dev» 8.x-dev

Well, we'd better move this back to D8 then.

xjm’s picture

Version:8.x-dev» 6.x-dev

Alright, it's pushed to D8 now. :)

Gábor Hojtsy’s picture

Status:Reviewed & tested by the community» Fixed

Thanks, committed, pushed.

Automatically closed -- issue fixed for 2 weeks with no activity.