Mention allowed characters in template ids in the reference page (inf…

…ra) (#1187) Mention allowed characters in template ids in the reference page Template ids, like job ids, should only include characters in [a-z0-9/-].
canonical · Apr 16, 2024 · 6fbcf94 · 6fbcf94
1 parent 2ee5cc4
commit 6fbcf94
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/docs/reference/units/job.rst b/docs/reference/units/job.rst
@@ -26,7 +26,7 @@ Following fields may be used by the job unit:
 ``id``:
     (mandatory) - A name for the job. Should be unique, an error will
     be generated if there are duplicates. Should contain characters in
-    [a-z0-9/-].
+    ``[a-z0-9/-]``.
     This field used to be called ``name``. That name is now deprecated. For
     backwards compatibility it is still recognized and used if ``id`` is
     missing.

diff --git a/docs/reference/units/template.rst b/docs/reference/units/template.rst
@@ -34,7 +34,8 @@ Template-Specific Fields
 .. _Template template-id field:
 
 ``template-id``
-    Unique identifier for this template.
+    Unique identifier for this template. Should contain characters in
+    ``[a-z0-9/-]``.
 
     This field is optional. If absent, a ``template-id`` value will be computed
     from the ``id`` field. For instance, if the ``id`` field is