Mercurial > p > roundup > code
diff doc/user_guide.txt @ 8255:7d72b9a9fe9c
docs: doc new types in user_guide; alphabetize types in reference.
user_guide.txt:
Removed Number from String and Number Properties. Added new Integer
and Number Properties sections to the user guide. Number Proprty
formats defined: no thousand separators, '.' decimal separator,
supports scientific 2E4 style input. Ordered in rough order of use.
reference.txt:
Alphabetized the types in the reference manual for easy lookup.
Fixed sentence on quiet property.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 01 Jan 2025 15:48:01 -0500 |
| parents | cae1bbf2536b |
| children | 2bf0c4e7795e |
line wrap: on
line diff
--- a/doc/user_guide.txt Wed Jan 01 09:54:32 2025 -0500 +++ b/doc/user_guide.txt Wed Jan 01 15:48:01 2025 -0500 @@ -114,11 +114,24 @@ for searching issues, the e-mail interface and even the command-line administration tool. -String and Numeric properties -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +String Properties +~~~~~~~~~~~~~~~~~ These fields just take a plain text value, like ``It's broken``. +Number Properties +~~~~~~~~~~~~~~~~~ + +These fields take a real number with decimal point like ``+12456.78``, +``-12456.78`` ``12456.78``. It supports scientific/exponent notation +like ``3.1415E-2``. Decimal commas (e.g. ``123456,78``) or thousand +separators ``-12,456.78`` are not supported. + +Integer Properties +~~~~~~~~~~~~~~~~~~ + +These fields take a whole/integer number without decimal marker like +``123``, ``+123``, ``-123``. Exponents are not supported. Boolean properties ~~~~~~~~~~~~~~~~~~