docs: Add comment to explain how info() works

canonical · Oct 22, 2024 · 46681c6 · 46681c6
1 parent 1ff2017
commit 46681c6
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/cou/steps/backup.py b/cou/steps/backup.py
@@ -47,7 +47,10 @@ async def backup(model: Model) -> Path:
     logger.info("SCP from mysql-innodb-cluster:%s to %s ...", remote_file, local_file)
     await model.scp_from_unit(unit_name, remote_file, str(local_file))
 
+    # info() stop the current spinner and print the text with
+    # symbol ℹ.
     progress_indicator.info(f"Backed up MySQL to {local_file}")
+    # Restart the spinner with previous text
     progress_indicator.start()
 
     logger.info("Remove permissions to read mysql-innodb-cluster:%s ...", basedir)