Problem/Motivation

The docs for the $sandbox parameter of hook_post_update_NAME() say:

 * @param array $sandbox
 *   Stores information for batch updates. See above for more information. 

...But there's no "above". This is the only time the sandbox size or batching in general are mentioned in the entire docblock.

It was obviously copied from the hook_update_N() docs, which do include an "above" paragraph explaining batching.

Proposed resolution

Copy the relevant docs to the docblock.

Remaining tasks

NR.

User interface changes

N/A

API changes

N/A

Data model changes

N/A

Release notes snippet

N/A (docs addition).

CommentFileSizeAuthor
#2 extension-3018774-1.patch1.28 KBxjm
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

xjm created an issue. See original summary.

xjm’s picture

Status: Active » Needs review
FileSize
1.28 KB
jibran’s picture

Status: Needs review » Reviewed & tested by the community

Docs change looks good to me.

catch’s picture

Status: Reviewed & tested by the community » Fixed

Committed and pushed a9472244bf to 8.7.x and 4047cb0e27 to 8.6.x. Thanks!

  • catch committed 4f02a38 on 8.7.x
    Issue #3018774 by xjm: hook_post_update_NAME() docs do not explain...

  • catch committed 4047cb0 on 8.6.x
    Issue #3018774 by xjm: hook_post_update_NAME() docs do not explain...

Status: Fixed » Closed (fixed)

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