aboutsummaryrefslogtreecommitdiff
path: root/doc/properties.rst
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-02-25 22:44:43 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-02-25 22:44:43 -0700
commit42990ceb5f7a9e14b89afd42a1cd91c7de4f3188 (patch)
tree7aa368567d7f84807f6714da706ba67f67e2a21a /doc/properties.rst
parent1938e99090ca34d6f20c4cf99391643ab1fc539f (diff)
downloadconsfigurator-42990ceb5f7a9e14b89afd42a1cd91c7de4f3188.tar.gz
:NOCHANGE -> :NO-CHANGE
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc/properties.rst')
-rw-r--r--doc/properties.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/properties.rst b/doc/properties.rst
index 6df06ff..771ef77 100644
--- a/doc/properties.rst
+++ b/doc/properties.rst
@@ -39,11 +39,11 @@ apply the property will always be made.
``:apply`` and ``:unapply`` subroutines
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Apply or unapply the property. Should return ``:nochange`` if the property
+Apply or unapply the property. Should return ``:no-change`` if the property
was already applied; any other return value is interpreted as meaning that the
property was not (fully) applied before we ran, but now it is. (If the
``:check`` function indicated that neither ``:apply`` nor ``:unapply`` should
-be run, then this is equivalent to those subroutines returning ``:nochange``.)
+be run, then this is equivalent to those subroutines returning ``:no-change``.)
The point of having both these return value semantics and the ``:check``
subroutine is that a property might only be able to check whether it made a