diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2021-02-12 09:20:39 +0100 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2021-02-12 09:20:39 +0100 |
| commit | adcf156405ccd9758f9c1e4e13650de54a121b49 (patch) | |
| tree | 4bb11fb9e172d71d1d08b4058c1a9341ae1cb9f8 | |
| parent | c3a5923a2a961fc61f1036eddc569bb3a1a4fa7f (diff) | |
Improve documentation for the auto properties of fields.
| -rw-r--r-- | docs/source/user/settings.rst | 15 |
1 files changed, 8 insertions, 7 deletions
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. |