diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2021-03-04 14:31:57 -0700 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2021-03-04 15:47:00 -0700 |
| commit | 55a3f7c5725dbf0af3172e69bd8cbfae5146429d (patch) | |
| tree | fc4afac9fd4a36f7891dd21f1d477147a7fcfa00 /doc/properties.rst | |
| parent | 81bfd98b98d21b2da12cd571f1da63cc80d84257 (diff) | |
| download | consfigurator-55a3f7c5725dbf0af3172e69bd8cbfae5146429d.tar.gz | |
distinguish between :DESC subroutines and docstrines in DEFPROP
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |