document dfhack.job.removeJob()

2023-01-14 01:07:18 -08:00 · 2023-01-14 01:07:18 -08:00 · 69e5730f77
parent 5f60791b39
commit 69e5730f77
1 changed files with 4 additions and 0 deletions
--- a/docs/dev/Lua
+++ b/docs/dev/Lua
@ -1144,6 +1144,10 @@ Job module

  Prints info about the job item.

+* ``dfhack.job.removeJob(job)``
+
+  Cancels a job, cleans up all references to it, and removes it from the world.
+
 * ``dfhack.job.getGeneralRef(job, type)``

  Searches for a general_ref with the given type.