diff options
Diffstat (limited to 'doc/properties.rst')
| -rw-r--r-- | doc/properties.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/properties.rst b/doc/properties.rst index ddae56b..e437a60 100644 --- a/doc/properties.rst +++ b/doc/properties.rst @@ -14,6 +14,13 @@ A property is composed of up to five subroutines, which all have the same lambda list (take the same arguments). At least one of ``:hostattrs``, ``:apply`` or ``:unapply`` must be present. +``:desc`` subroutines +~~~~~~~~~~~~~~~~~~~~~ + +Pure function of the property's arguments which returns a description of +applying the property, to be used in stdout by deployments to inform the user +what work is being done. + ``:preprocess`` subroutines ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |