File tree Expand file tree Collapse file tree 2 files changed +22
-1
lines changed
Expand file tree Collapse file tree 2 files changed +22
-1
lines changed Original file line number Diff line number Diff line change @@ -672,6 +672,27 @@ A Class is comprised of one or more properties of the following types:
672672Properties can have additional attributes to change the default
673673behaviour:
674674
675+ * All properties support the following attributes:
676+
677+ - ``required``: see `design documentation`_. Adds the property to
678+ the list returned by calling get_required_props for the class.
679+ - ``default_value``: see `design documentation`_ Sets the default
680+ value is the property is not set.
681+ - ``quiet``: see `design documentation`_. Suppresses user visible
682+ to changes to this property. The property change is not reported:
683+
684+ - in the change feedback/confirmation message in the web
685+ interface
686+ - the property change section of the nosy email
687+ - the web history at the bottom of an item's page
688+
689+ This can be used to store state of the user interface (e.g. the
690+ names of elements that are collapsed or hidden from the
691+ user). Making properties that are updated as an indirect result of
692+ a user's change (e.g. updating a blockers property, counting
693+ number of times an issue was reopened or reassigned etc.) should
694+ not be displayed to the user as they can be confusing.
695+
675696* String properties can have an ``indexme`` attribute that defines if the
676697 property should be part of the full text index. The default is 'no' but this
677698 can be set to 'yes' to allow a property's contents to be in the full
Original file line number Diff line number Diff line change @@ -260,7 +260,7 @@ All property objects support the following settings:
260260
261261quiet=False:
262262 if set to True, changes to the property will not be shown to the
263- user. This can be used for adminstrative properties that are
263+ user. This can be used for administrative properties that are
264264 automatically updated when a user makes some other change. This
265265 reduces confusion by the user and clutter in the display.
266266 The property change will not be shown in:
You can’t perform that action at this time.
0 commit comments