From 23f186f93f8d26943797c830a9958034d8c3b47f Mon Sep 17 00:00:00 2001 From: Laurent Monin Date: Fri, 29 Mar 2024 11:32:14 +0100 Subject: [PATCH] Add a note about upgrade hook docstring --- picard/config_upgrade.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/picard/config_upgrade.py b/picard/config_upgrade.py index 6c567e69b4d..609ef2ed6a1 100644 --- a/picard/config_upgrade.py +++ b/picard/config_upgrade.py @@ -71,6 +71,9 @@ # # The only parameter passed is `config`. # To rename old option to new one, use helper method `rename_option()`. +# +# Note: it is important to describe changes made by the method using a docstring. +# The text can be logged when the hook is executed. def upgrade_to_v1_0_0final0(config):