From 55a3f7c5725dbf0af3172e69bd8cbfae5146429d Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Thu, 4 Mar 2021 14:31:57 -0700 Subject: distinguish between :DESC subroutines and docstrines in DEFPROP Signed-off-by: Sean Whitton --- doc/properties.rst | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc/properties.rst') 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3