Skip to content

Commit 7f04d35

Browse files
committed
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.
1 parent 1d8c86f commit 7f04d35

File tree

2 files changed

+30
-17
lines changed

2 files changed

+30
-17
lines changed

doc/reference.txt

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -442,32 +442,32 @@ Properties
442442

443443
A Class consists of one or more properties of the following types:
444444

445-
String
446-
properties store arbitrary-length strings.
447-
Password
448-
properties store encoded arbitrary-length strings.
449-
The default encoding is defined in the ``roundup.password.Password``
450-
class.
445+
Boolean
446+
properties store on/off, yes/no, true/false values.
451447
Date
452448
properties store date-and-time stamps. Their values are Timestamp
453449
objects.
450+
Integer
451+
properties store integer values. (Number can store real/float values.)
454452
Interval
455453
properties store time periods rather than absolute dates. For
456454
example 2 hours.
457-
Integer
458-
properties store integer values. (Number can store real/float values.)
459-
Number
460-
properties store numeric values. There is an option to use
461-
double-precision floating point numbers.
462-
Boolean
463-
properties store on/off, yes/no, true/false values.
464455
Link
465456
properties refers to a single item selected from a
466457
specified class. The class is part of the property; the value is an
467458
integer, the id of the chosen item.
468459
Multilink
469460
properties refer to one or more items in a specified
470461
class. The value is a list of integers.
462+
Number
463+
properties store numeric values. There is an option to use
464+
double-precision floating point numbers.
465+
Password
466+
properties store encoded arbitrary-length strings.
467+
The default encoding is defined in the ``roundup.password.Password``
468+
class.
469+
String
470+
properties store arbitrary-length strings.
471471

472472
Properties have attributes to change the default behaviour:
473473

@@ -481,8 +481,8 @@ Properties have attributes to change the default behaviour:
481481
the list returned by calling get_required_props for the class.
482482
- ``default_value``: see `design documentation`_ Sets the default
483483
value if the property is not set.
484-
- ``quiet``: see `design documentation`_. Suppresses user visible
485-
to changes to this property. The property change is not reported:
484+
- ``quiet``: see `design documentation`_. Suppresses reporting user
485+
visible changes to this property. The property change is not reported:
486486

487487
- in the change feedback/confirmation message in the web
488488
interface

doc/user_guide.txt

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,24 @@ This means the web interface for entering a new issue, the web interface
114114
for searching issues, the e-mail interface and even the command-line
115115
administration tool.
116116

117-
String and Numeric properties
118-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
117+
String Properties
118+
~~~~~~~~~~~~~~~~~
119119

120120
These fields just take a plain text value, like ``It's broken``.
121121

122+
Number Properties
123+
~~~~~~~~~~~~~~~~~
124+
125+
These fields take a real number with decimal point like ``+12456.78``,
126+
``-12456.78`` ``12456.78``. It supports scientific/exponent notation
127+
like ``3.1415E-2``. Decimal commas (e.g. ``123456,78``) or thousand
128+
separators ``-12,456.78`` are not supported.
129+
130+
Integer Properties
131+
~~~~~~~~~~~~~~~~~~
132+
133+
These fields take a whole/integer number without decimal marker like
134+
``123``, ``+123``, ``-123``. Exponents are not supported.
122135

123136
Boolean properties
124137
~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)