Skip to content

Commit 3467cd5

Browse files
docs: Add missing days parameter to microbit.run_every. (bbcmicrobit#767)
1 parent ead7ac0 commit 3467cd5

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/microbit.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Functions
7676
:param n: An integer or floating point number indicating the number of
7777
milliseconds to wait.
7878

79-
.. py:function:: run_every(callback, h=None, min=None, s=None, ms=None)
79+
.. py:function:: run_every(callback, days=None, h=None, min=None, s=None, ms=None)
8080
8181
Schedule to run a function at the interval specified by the time arguments.
8282

@@ -85,7 +85,7 @@ Functions
8585
* As a **Decorator** - placed on top of the function to schedule.
8686
For example::
8787

88-
@run_every(h=1, min=20, s=30, ms=50)
88+
@run_every(days=1, h=1, min=20, s=30, ms=50)
8989
def my_function():
9090
# Do something here
9191

@@ -96,14 +96,15 @@ Functions
9696
# Do something here
9797
run_every(my_function, s=30)
9898

99-
Each arguments corresponds to a different time unit and they are additive.
99+
Each argument corresponds to a different time unit and they are additive.
100100
So ``run_every(min=1, s=30)`` schedules the callback every minute and
101101
a half.
102102

103103
When an exception is thrown inside the callback function it deschedules
104104
the function. To avoid this you can catch exceptions with ``try/except``.
105105

106106
:param callback: Function to call at the provided interval.
107+
:param days: Sets the days mark for the scheduling.
107108
:param h: Sets the hour mark for the scheduling.
108109
:param min: Sets the minute mark for the scheduling.
109110
:param s: Sets the second mark for the scheduling.

0 commit comments

Comments
 (0)