API page: http://api.drupal.org/api/drupal/modules%21system%21system.api.php/funct...

Enter a descriptive title (above) relating to function hook_install_tasks, then describe the problem you have found:

The nested bullets in the @return for 'type' and 'run' are broken.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

markpavlitski’s picture

Status: Active » Needs review
FileSize
3.84 KB

This looks like an indenting issue. Patch attached.

jhodgdon’s picture

Status: Needs review » Needs work

Thanks! There is still some list formatting problem here:

 *     - 'run'
  *       A constant representing the manner in which the task will be run. This
 

This should be:

 *     - run: A constant representing the manner in which the task will be run. This

There should not be '' around 'run', and it should be followed by a : and the description. See
http://drupal.org/node/1354#lists

If you could fix up the whole @return area, that would be great!

markpavlitski’s picture

Status: Needs work » Needs review
FileSize
6.75 KB

@jhodgdon Thanks for the feedback.

Amended patch attached.

jhodgdon’s picture

Status: Needs review » Needs work

Excellent! The only remaining list formatting problem is that the whole list should be indented less. It should be:

 * @return array
 *   Text text text text ... :
 *   - list_item_1: text text text ...
 *     more text more text:
 *     - sub_list_item: text text text

not

 * @return array
 *   Text text text text ... :
 *     - list_item_1: text text text ...
 *       more text more text:
 *       - sub_list_item: text text text

Thanks!

markpavlitski’s picture

Status: Needs work » Needs review
FileSize
6.22 KB

Apologies, I hadn't spotted that. Thanks again!

jhodgdon’s picture

Assigned: Unassigned » jhodgdon
Status: Needs review » Reviewed & tested by the community

Perfect! Thanks for the quick work. I'll get this committed shortly (assuming the test turns green).

jhodgdon’s picture

Assigned: jhodgdon » Unassigned
Status: Reviewed & tested by the community » Fixed

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

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