Skip to content

Commit

Permalink
Add example to the Template unit template-summary field (Infra) (cano…
Browse files Browse the repository at this point in the history
…nical#1097)

Add example to the Template unit template-summary field
  • Loading branch information
pieqq authored and binli committed Mar 22, 2024
1 parent dcbd618 commit 76dbead
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/reference/units/template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ Template-Specific Fields
translation into other languages. It must be one line long, ideally it
should be short (50-70 characters max).

Example: if a template has a ``summary`` field is set to:

*Test serial connection for port {serial_port}*

then its ``template-summary`` could be:

*Test serial connection for every serial port on the system*

This field is optional (Checkbox will only advise you to provide one when
running provider validation).

Expand Down

0 comments on commit 76dbead

Please sign in to comment.