summaryrefslogtreecommitdiff
path: root/docs/source/configuration/alotrc_table
diff options
context:
space:
mode:
authorDylan Baker <dylan@pnwbakers.com>2017-01-25 15:52:58 -0800
committerDylan Baker <dylan@pnwbakers.com>2017-01-26 13:40:27 -0800
commit0511526d97cb6a74282c5f4dd334be1f5f355ea0 (patch)
tree7c150de01bc2e60c3194381475d124e2d582f765 /docs/source/configuration/alotrc_table
parenta2f001df1176f14bb18d82687b4c42721bd02efd (diff)
Implement a hook that runs periodically
This creates a deferred that runs on a user configurable timer and is provided the ui. This deferred will re-fire after the number of seconds specified by the timer are eclipsed. By default this is 300 seconds. Fixes #522
Diffstat (limited to 'docs/source/configuration/alotrc_table')
-rw-r--r--docs/source/configuration/alotrc_table10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/source/configuration/alotrc_table b/docs/source/configuration/alotrc_table
index 9e27b206..6929a665 100644
--- a/docs/source/configuration/alotrc_table
+++ b/docs/source/configuration/alotrc_table
@@ -385,6 +385,16 @@
:default: 2
+.. _periodic-hook-frequency:
+
+.. describe:: periodic_hook_frequency
+
+ The number of seconds to wait between calls to the loop_hook
+
+ :type: integer
+ :default: 300
+
+
.. _prefer-plaintext:
.. describe:: prefer_plaintext