From 72807b9ea74b59eba0f64b6fd5978a09abb8b0a4 Mon Sep 17 00:00:00 2001 From: Pragmatic Software Date: Sun, 8 Mar 2020 17:59:05 -0700 Subject: [PATCH] doc: improvements --- doc/Admin.md | 8 ++++---- doc/README.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/Admin.md b/doc/Admin.md index 30ecc69f..aec7c75a 100644 --- a/doc/Admin.md +++ b/doc/Admin.md @@ -56,7 +56,7 @@ * [cmdset](#cmdset) * [cmdunset](#cmdunset) * [Command metadata list](#command-metadata-list) -* [Event queue commands](#event-queue-commands) +* [Event queue management](#event-queue-management) * [eventqueue](#eventqueue) * [Process management commands](#process-management-commands) * [ps](#ps) @@ -544,18 +544,18 @@ Name | Description `background-process` | When set to a true value then this command will be executed as a background process. Use this for commands that can potentially take a long time to complete. `process-timeout` | The timeout, in seconds, before the process is automatically killed. If not set then the `processmanager.default_timeout` [registry](Registry.md) value will be used. -## Event queue commands +## Event queue management ### eventqueue Manages the PBot event queue. Can be used to add commands that run at a future time. -Usage: `eventqueue list [filter regex] | add | delete ` +Usage: `eventqueue list [filter regex] | add | remove ` For example, to schedule a command to run 1 hour from now: eventqueue add "1 hour" echo Ta-da! Command added to event queue. - eventqueue list echo + eventqueue list Queued events: 1) in 1h: output #channel /say Ta-da! ... 1 hour later ... diff --git a/doc/README.md b/doc/README.md index da9e1dbd..39722b94 100644 --- a/doc/README.md +++ b/doc/README.md @@ -130,7 +130,7 @@ * [cmdset](Admin.md#cmdset) * [cmdunset](Admin.md#cmdunset) * [Command metadata list](Admin.md#command-metadata-list) - * [Event queue commands](Admin.md#event-queue-commands) + * [Event queue management](Admin.md#event-queue-management) * [eventqueue](Admin.md#eventqueue) * [Process management commands](Admin.md#process-management-commands) * [ps](Admin.md#ps)