Documentation updates related to task names

kwikwag · Jan 13, 2022 · 9387c52 · 9387c52
1 parent bc13e2f
commit 9387c52
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/userguide/periodic-tasks.rst b/docs/userguide/periodic-tasks.rst
@@ -170,6 +170,10 @@ Available Fields
 
     The name of the task to execute.
 
+    Task names are described in the :ref:`task-names` section of the User Guide.
+    Note that this is not the import path of the task, even though the default
+    naming pattern is built like it is.
+
 * `schedule`
 
     The frequency of execution.

diff --git a/docs/userguide/tasks.rst b/docs/userguide/tasks.rst
@@ -237,6 +237,12 @@ named :file:`tasks.py`:
     >>> add.name
     'tasks.add'
 
+.. note::
+
+   You can use the `inspect` command in a worker to view the names of
+   all registered tasks. See the `inspect registered` command in the
+   :ref:`monitoring-control` section of the User Guide.
+
 .. _task-name-generator-info:
 
 Changing the automatic naming behavior