[WelcomeScreen.py] Added hints on the time unit of the parameters!

This commit is contained in:
BlueFox 2024-10-28 19:31:54 +00:00
parent 53d80e4068
commit dc3098095c

View File

@ -47,13 +47,13 @@ class WelcomeScreen:
# --- # ---
# cycles says how often the Starting text goes through # cycles says how often the Starting text goes through
# --- # ---
# wait_after_cycles is an integer number defining how long to wait before returning / if fading # wait_after_cycles is a number in seconds (can be float) defining how long to wait before returning OR
# out is activated, the time to wait between end of the cycling animation and the fade out animation # if fading out is activated, the time to wait between end of the cycling animation and the fade out animation
# --- # ---
# fade_down is a dict with following keys: # fade_down is a dict with following keys:
# - "enabled" - REQUIRED - wether fading is enabled (default: true) # - "enabled" - REQUIRED - wether fading is enabled (default: true)
# - "wait_between" - OPTIONAL - the time to wait between each line fade # - "wait_between" - OPTIONAL - the time in seconds to wait between each line fade
# - "wait_after" - OPTIONAL - the time to wait after the fade out # - "wait_after" - OPTIONAL - the time in seconds to wait after the fade out
# --- # ---
# interruptable influences wether the program can be interrupted by pins in the self.interrupt_pins list # interruptable influences wether the program can be interrupted by pins in the self.interrupt_pins list
# if this list is empty, even when interruptable is set to true, nothing will be able to interrupt! # if this list is empty, even when interruptable is set to true, nothing will be able to interrupt!