summaryrefslogtreecommitdiffstats
path: root/examples/xmonad
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2014-03-27 17:10:18 +0100
committerMattias Andrée <maandree@operamail.com>2014-03-27 17:10:18 +0100
commit9ed04886b05f30a135385e84ed7f0c618a3a8ab1 (patch)
treeb3c8d6b6c6202ab0b6861906520d49c50ec00611 /examples/xmonad
parentupdate todo (diff)
downloadblueshift-9ed04886b05f30a135385e84ed7f0c618a3a8ab1.tar.gz
blueshift-9ed04886b05f30a135385e84ed7f0c618a3a8ab1.tar.bz2
blueshift-9ed04886b05f30a135385e84ed7f0c618a3a8ab1.tar.xz
m doc
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r--examples/xmonad40
1 files changed, 19 insertions, 21 deletions
diff --git a/examples/xmonad b/examples/xmonad
index 3a4cd23..8256e23 100644
--- a/examples/xmonad
+++ b/examples/xmonad
@@ -132,8 +132,6 @@ def get_workspaces():
last = (-1, '')
def periodically(year, month, day, hour, minute, second, weekday, fade):
'''
- :(int, int, int, int, int, int, int, float?)?→void Place holder for periodically invoked function
-
Invoked periodically
If you want to control at what to invoke this function next time
@@ -141,25 +139,25 @@ def periodically(year, month, day, hour, minute, second, weekday, fade):
number of seconds to wait before invoking this function again.
The value does not need to be an integer.
- @param year:int The year
- @param month:int The month, 1 = January, 12 = December
- @param day:int The day, minimum value is 1, probable maximum value is 31 (*)
- @param hour:int The hour, minimum value is 0, maximum value is 23
- @param minute:int The minute, minimum value is 0, maximum value is 59
- @param second:int The second, minimum value is 0, probable maximum value is 60 (**)
- @param weekday:int The weekday, 1 = Monday, 7 = Sunday
- @param fade:float? Blueshift can use this function to fade into a state when it start
- or exits. `fade` can either be negative, zero or positive or `None`,
- but the magnitude of value cannot exceed 1. When Blueshift starts,
- the this function will be invoked multiple with the time parameters
- of the time it is invoked and each time `fade` will increase towards
- 1, starting at 0, when the value is 1, the settings should be applied
- to 100 %. After this this function will be invoked once again with
- `fade` being `None`. When Blueshift exits the same behaviour is used
- except, `fade` decrease towards -1 but start slightly below 0, when
- -1 is reached all settings should be normal. Then Blueshift will NOT
- invoke this function with `fade` being `None`, instead it will by
- itself revert all settings and quit.
+ @param year:int The year
+ @param month:int The month, 1 = January, 12 = December
+ @param day:int The day, minimum value is 1, probable maximum value is 31 (*)
+ @param hour:int The hour, minimum value is 0, maximum value is 23
+ @param minute:int The minute, minimum value is 0, maximum value is 59
+ @param second:int The second, minimum value is 0, probable maximum value is 60 (**)
+ @param weekday:int The weekday, 1 = Monday, 7 = Sunday
+ @param fade:float? Blueshift can use this function to fade into a state when it start
+ or exits. `fade` can either be negative, zero or positive or `None`,
+ but the magnitude of value cannot exceed 1. When Blueshift starts,
+ the this function will be invoked multiple with the time parameters
+ of the time it is invoked and each time `fade` will increase towards
+ 1, starting at 0, when the value is 1, the settings should be applied
+ to 100 %. After this this function will be invoked once again with
+ `fade` being `None`. When Blueshift exits the same behaviour is used
+ except, `fade` decrease towards -1 but start slightly below 0, when
+ -1 is reached all settings should be normal. Then Blueshift will NOT
+ invoke this function with `fade` being `None`, instead it will by
+ itself revert all settings and quit.
(*) Can be exceeded if the calendar system is changed, like in 1712-(02)Feb-30
(**) See https://en.wikipedia.org/wiki/Leap_second