diff --git a/core/modules/system/system.api.php b/core/modules/system/system.api.php index ed5b7a0..b551cc0 100644 --- a/core/modules/system/system.api.php +++ b/core/modules/system/system.api.php @@ -2915,12 +2915,12 @@ function hook_install() { /** * Perform a single update. * - * For each patch which requires a database change add a new hook_update_N() - * which will be called by update.php. The database updates are numbered - * sequentially according to the version of Drupal you are compatible with. - * - * Schema updates should adhere to the Schema API: - * @link http://drupal.org/node/150215 http://drupal.org/node/150215 @endlink + * For each change that requires one or more actions to be performed when + * updating a site, add a new hook_update_N(), which will be called by + * update.php. The documentation block preceding this function is stripped of + * newlines and used as the description for the update on the pending update + * task list. Schema updates should adhere to the + * @link http://drupal.org/node/150215 Schema API.@endlink * * Database updates consist of 3 parts: * - 1 digit for Drupal core compatibility @@ -2960,8 +2960,8 @@ function hook_install() { * information between successive calls, and the $sandbox['#finished'] value * to provide feedback regarding completion level. * - * See the batch operations page for more information on how to use the batch API: - * @link http://drupal.org/node/180528 http://drupal.org/node/180528 @endlink + * See the batch operations page for more information on how to use the + * @link http://drupal.org/node/180528 Batch API.@endlink * * @param $sandbox * Stores information for multipass updates. See above for more information. @@ -2973,9 +2973,14 @@ function hook_install() { * PDOException. * * @return - * Optionally update hooks may return a translated string that will be displayed - * to the user. If no message is returned, no message will be presented to the - * user. + * Optionally, update hooks may return a translated string that will be + * displayed to the user after the update has completed. If no message is + * returned, no message will be presented to the user. + * + * @see batchapi + * @see schemaapi + * @see hook_update_last_removed() + * @see update_get_update_list() */ function hook_update_N(&$sandbox) { // For non-multipass updates, the signature can simply be;