docs: Updated docs for version 4.16

neilmunday · May 8, 2024 · 0d34124 · 0d34124
1 parent b45712f
commit 0d34124
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -242,14 +242,16 @@ Slurm-Mail uses Python's [string.Template](https://docs.python.org/3/library/str
 | Filename                  | Template Purpose                                                  |
 | ------------------------- | ----------------------------------------------------------------- |
 | ended-array.tpl           | Used for jobs in an array that have finished.                     |
-| ended-array_summary       | Used when all jobs in an array have finished.                     |
+| ended-array_summary.tpl   | Used when all jobs in an array have finished.                     |
+| ended-hetjob.tpl          | Used for the leader job in a heterogeneous job that has ended.    |
 | ended.tpl                 | Used for jobs that have finished.                                 |
 | invalid-dependency.tpl    | Used when a job has an invalid dependency.                        |
 | job-table.tpl             | Used to create the job info table in e-mails.                     |
 | never-ran.tpl             | Used for jobs that never ran.                                     |
 | signature.tpl             | Used to create the e-mail signature.                              |
 | staged-out.tpl            | Used when a job's burst buffer stage has completed.               |
 | started.tpl               | Used for jobs that have started.                                  |
+| started-hetjob.tpl        | Used for the leader job in a heterogeneous job that has started.  |                                 |
 | started-array-summary.tpl | Used when the first job in an array has started.                  |
 | started-array.tpl         | Used for the first job in an array that has started.              |
 | time.tpl                  | Used when a job reaches a percentage of it's time limit.          |

diff --git a/TEMPLATES.md b/TEMPLATES.md
@@ -17,7 +17,7 @@ HTML and plain text templates can be found at: `/etc/slurm-mail/templates/html`
 | $SIGNATURE    | E-mail signature                                             |
 | $USER         | The user's name.                                             |
 
-## ended.tpl
+## ended.tpl, ended-hetjob.tpl
 
 | Variable    | Purpose                                                      |
 | ----------- | ------------------------------------------------------------ |
@@ -104,7 +104,7 @@ Note: some variables are only displayed in the e-mail if the job has ended.
 | $SIGNATURE    | E-mail signature                                           |
 | $USER         | The user's name.                                           |
 
-## started.tpl
+## started.tpl, started-hetjob.tpl
 
 | Variable      | Purpose                                                    |
 | ------------- | ---------------------------------------------------------- |