From db8164b7df8b4927b918bacd7ee3d6d960c465e2 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Sat, 6 Mar 2021 01:19:06 -0800
Subject: [PATCH] dev/release#16 - Tweak docblocks to be clear about need for
explicit version declarations
---
CRM/Upgrade/Incremental/php/FiveThirtySeven.php | 7 +++++--
CRM/Upgrade/Incremental/php/Template.php | 7 +++++--
2 files changed, 10 insertions(+), 4 deletions(-)
diff --git a/CRM/Upgrade/Incremental/php/FiveThirtySeven.php b/CRM/Upgrade/Incremental/php/FiveThirtySeven.php
index bad13a5b51d..3f4ea75796e 100644
--- a/CRM/Upgrade/Incremental/php/FiveThirtySeven.php
+++ b/CRM/Upgrade/Incremental/php/FiveThirtySeven.php
@@ -16,8 +16,8 @@ class CRM_Upgrade_Incremental_php_FiveThirtySeven extends CRM_Upgrade_Incrementa
/**
* Compute any messages which should be displayed beforeupgrade.
*
- * Note: This function is called iteratively for each upcoming
- * revision to the database.
+ * Note: This function is called iteratively for each incremental upgrade step.
+ * There must be a concrete step (eg 'X.Y.Z.mysql.tpl' or 'upgrade_X_Y_Z()').
*
* @param string $preUpgradeMessage
* @param string $rev
@@ -34,6 +34,9 @@ class CRM_Upgrade_Incremental_php_FiveThirtySeven extends CRM_Upgrade_Incrementa
/**
* Compute any messages which should be displayed after upgrade.
*
+ * Note: This function is called iteratively for each incremental upgrade step.
+ * There must be a concrete step (eg 'X.Y.Z.mysql.tpl' or 'upgrade_X_Y_Z()').
+ *
* @param string $postUpgradeMessage
* alterable.
* @param string $rev
diff --git a/CRM/Upgrade/Incremental/php/Template.php b/CRM/Upgrade/Incremental/php/Template.php
index 3f9d3971dcc..debafbfa8a8 100644
--- a/CRM/Upgrade/Incremental/php/Template.php
+++ b/CRM/Upgrade/Incremental/php/Template.php
@@ -22,8 +22,8 @@ class CRM_Upgrade_Incremental_php_<?php echo $camelNumber; ?> extends CRM_Upgrad
/**
* Compute any messages which should be displayed beforeupgrade.
*
- * Note: This function is called iteratively for each upcoming
- * revision to the database.
+ * Note: This function is called iteratively for each incremental upgrade step.
+ * There must be a concrete step (eg 'X.Y.Z.mysql.tpl' or 'upgrade_X_Y_Z()').
*
* @param string $preUpgradeMessage
* @param string $rev
@@ -40,6 +40,9 @@ class CRM_Upgrade_Incremental_php_<?php echo $camelNumber; ?> extends CRM_Upgrad
/**
* Compute any messages which should be displayed after upgrade.
*
+ * Note: This function is called iteratively for each incremental upgrade step.
+ * There must be a concrete step (eg 'X.Y.Z.mysql.tpl' or 'upgrade_X_Y_Z()').
+ *
* @param string $postUpgradeMessage
* alterable.
* @param string $rev
--
GitLab