From 150309f10a95287fcd266b05c47190979d3389e9 Mon Sep 17 00:00:00 2001 From: "John L. Villalovos" Date: Wed, 4 Feb 2015 13:18:49 -0800 Subject: [PATCH] Documentation: Describe the 'spacing' argument Explain that the 'spacing' argument takes number of seconds. So 'spacing=5' means to run every 5 seconds. Change-Id: I3b58fbe5c0adfd7f659d6c098533804bbf00d778 Signed-off-by: John L. Villalovos --- doc/source/dev/architecture.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/source/dev/architecture.rst b/doc/source/dev/architecture.rst index 3abbd05703..8a6d6f985e 100644 --- a/doc/source/dev/architecture.rst +++ b/doc/source/dev/architecture.rst @@ -98,7 +98,8 @@ driver itself or on any interface with driver_periodic_task_ decorator, e.g. pass # do something fast, this blocks other tasks from starting! -Here ``spacing`` argument is a period for a given periodic task. +Here the ``spacing`` argument is a period in seconds for a given periodic task. +For example 'spacing=5' means every 5 seconds. The ``parallel`` argument may be passed to driver_periodic_task_ and defaults to True. If False, this task will be run in the periodic task loop, rather