From adcf156405ccd9758f9c1e4e13650de54a121b49 Mon Sep 17 00:00:00 2001
From: Elena ``of Valhalla'' Grandi <valhalla@trueelena.org>
Date: Fri, 12 Feb 2021 09:20:39 +0100
Subject: Improve documentation for the auto properties of fields.
---
docs/source/user/settings.rst | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
(limited to 'docs/source/user')
diff --git a/docs/source/user/settings.rst b/docs/source/user/settings.rst
index c781f11..e951621 100644
--- a/docs/source/user/settings.rst
+++ b/docs/source/user/settings.rst
@@ -76,15 +76,15 @@ Some field types may add other custom properties.
The value of ``increment`` will autoincrement the value at every
update.
- The reference client will run this update before editing an entry,
- allowing further changes from the user; a command line user can then
- decide to abort this change through the usual git commands.
+ The reference command-line client will run this update before editing
+ an entry, allowing further changes from the user; a command line user
+ can then decide to abort this change through the usual git commands.
Other clients may decide to use a different workflow.
``increment``:
the amount by which an ``auto: increment`` field is incremented
- (negative values are of course allowed).
+ (negative values are of course allowed). Default is 1.
``date`` and ``datetime`` properties
------------------------------------
@@ -101,9 +101,10 @@ Some field types may add other custom properties.
autofill the field when it is updated with the current UTC time
(``datetime``) or local zone day (``date``).
- The reference client will run this update before editing an entry,
- allowing further changes from the user; a command line user can
- then decide to abort this change through the usual git commands.
+ The reference command line client will run this update before
+ editing an entry, allowing further changes from the user; a
+ command line user can then decide to abort this change through the
+ usual git commands.
Other clients may decide to use a different workflow.
--
cgit v1.2.3