Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention allowed characters in template ids in the reference page (infra) #1187

Merged
merged 1 commit into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/units/job.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/units/template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading