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!
Comment | File | Size | Author |
---|---|---|---|
#13 | 1436074_13.patch | 752 bytes | tstoeckler |
#12 | 1436074_11_D7.patch | 752 bytes | Pat Redmond |
#11 | 1436074_11_D7.patch | 752 bytes | Pat Redmond |
#5 | batch_set_1436074_5.patch | 778 bytes | Pat Redmond |
Comments
Comment #1
jhodgdonGood catch!
Comment #2
Pat Redmond CreditAttribution: Pat Redmond commentedHow 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...?
Comment #3
webchickYou would find this documentation in the core/includes/form.inc file, just above the function called "batch_set".
Comment #4
jhodgdonInstructions 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)
Comment #5
Pat Redmond CreditAttribution: Pat Redmond commentedAh, 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.
Comment #6
jhodgdonLooks 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).
Comment #7
Pat Redmond CreditAttribution: Pat Redmond commentedOK, 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?
Comment #8
tstoecklerOne 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.
Comment #9
Dries CreditAttribution: Dries commentedCommitted to 7.x and 8.x. Thanks!
Comment #10
jhodgdonStill needs backport to D6.
Comment #11
Pat Redmond CreditAttribution: Pat Redmond commentedD6 patch
Comment #12
Pat Redmond CreditAttribution: Pat Redmond commentedD6 patch - even though it is named D7
Comment #13
tstoecklerUploading indentical (!) patch without D7 suffix so it can get a date with the bot.
Comment #14
tstoecklerAlso this is RTBC.
I did not change a single character in the patch, so I'm not marking my own patch RTBC.
Comment #15
Pat Redmond CreditAttribution: Pat Redmond commentedWhat is RTBC?
Comment #16
Pat Redmond CreditAttribution: Pat Redmond commentedReady To Be Committed...
Do I need to mark it as RTBC?
Comment #17
tstoecklerIn 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. :)
Comment #18
xjmI see this commit in D7, but not in D8.
Comment #19
jhodgdonWell, we'd better move this back to D8 then.
Comment #20
xjmAlright, it's pushed to D8 now. :)
Comment #21
Gábor HojtsyThanks, committed, pushed.