From 43121fbe8b952bb4173a2da9f7ca6dfa18b3a799 Mon Sep 17 00:00:00 2001 From: Nicolas Roeser Date: Mon, 11 Mar 2019 13:12:24 +0100 Subject: [PATCH] MDL-64790 upgrade: parameter API doc regression fix Partially update the API documentation of function upgrade_plugin_savepoint. This restores consistency between function parameters and API documentation; as commit 17da2e6f28d3477eb4ccfe5ac94c9cebb8456c8e (fix for MDL-16438) had renamed parameter $dir to $plugin, but not also applied this change to the API documentation. Also reword the parameter comment text so that it is more meaningful to developers: document that the parameter contains the name of the plugin. Change the API documentation of parameter $type as well so that it is a) correct, and b) not in conflict with the API documentation for $plugin. --- lib/upgradelib.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/upgradelib.php b/lib/upgradelib.php index 1490e50bf87..ed5f775ae13 100644 --- a/lib/upgradelib.php +++ b/lib/upgradelib.php @@ -383,8 +383,8 @@ function upgrade_block_savepoint($result, $version, $blockname, $allowabort=true * @category upgrade * @param bool $result false if upgrade step failed, true if completed * @param string or float $version main version - * @param string $type name of plugin - * @param string $dir location of plugin + * @param string $type The type of the plugin. + * @param string $plugin The name of the plugin. * @param bool $allowabort allow user to abort script execution here * @return void */