Skip to content

Commit

Permalink
Add a note about upgrade hook docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
zas committed Mar 29, 2024
1 parent 092f301 commit 23f186f
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions picard/config_upgrade.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down

0 comments on commit 23f186f

Please sign in to comment.