Skip to content

Commit 2c31b46

Browse files
committed
Fix: nested lists, wide example, wiki schema examples
1 parent 3c48d53 commit 2c31b46

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

doc/customizing.txt

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -851,24 +851,24 @@ behaviour:
851851

852852
* All properties support the following attributes:
853853

854-
- ``required``: see `design documentation`_. Adds the property to
855-
the list returned by calling get_required_props for the class.
856-
- ``default_value``: see `design documentation`_ Sets the default
857-
value if the property is not set.
858-
- ``quiet``: see `design documentation`_. Suppresses user visible
859-
to changes to this property. The property change is not reported:
860-
861-
- in the change feedback/confirmation message in the web
862-
interface
863-
- the property change section of the nosy email
864-
- the web history at the bottom of an item's page
865-
866-
This can be used to store state of the user interface (e.g. the
867-
names of elements that are collapsed or hidden from the
868-
user). Making properties that are updated as an indirect result of
869-
a user's change (e.g. updating a blockers property, counting
870-
number of times an issue was reopened or reassigned etc.) should
871-
not be displayed to the user as they can be confusing.
854+
- ``required``: see `design documentation`_. Adds the property to
855+
the list returned by calling get_required_props for the class.
856+
- ``default_value``: see `design documentation`_ Sets the default
857+
value if the property is not set.
858+
- ``quiet``: see `design documentation`_. Suppresses user visible
859+
to changes to this property. The property change is not reported:
860+
861+
- in the change feedback/confirmation message in the web
862+
interface
863+
- the property change section of the nosy email
864+
- the web history at the bottom of an item's page
865+
866+
This can be used to store state of the user interface (e.g. the
867+
names of elements that are collapsed or hidden from the
868+
user). Making properties that are updated as an indirect result of
869+
a user's change (e.g. updating a blockers property, counting
870+
number of times an issue was reopened or reassigned etc.) should
871+
not be displayed to the user as they can be confusing.
872872

873873
.. index:: triple: schema; property attributes; indexme
874874

@@ -1091,21 +1091,20 @@ interface. Note that this will NOT result in an entry in the journal,
10911091
so again it allows a silent change. To do this you need to make two
10921092
rest requests. An example using curl is::
10931093

1094-
$ curl -u demo:demo -s
1095-
-H "X-requested-with: rest" \
1096-
-H "Referer: https://tracker.example.com/demo/" \
1097-
-X GET \
1098-
https://tracker.example.com/demo/rest/data/file/30/content
1099-
{
1100-
"data": {
1101-
"id": "30",
1102-
"type": "<class 'str'>",
1103-
"link": "https://tracker.example.com/demo/rest/data/file/30/conten
1104-
t",
1105-
"data": "hello3",
1106-
"@etag": "\"3f2f8063dbce5b6bd43567e6f4f3c671\""
1107-
}
1108-
}
1094+
$ curl -u demo:demo -s
1095+
-H "X-requested-with: rest" \
1096+
-H "Referer: https://tracker.example.com/demo/" \
1097+
-X GET \
1098+
https://tracker.example.com/demo/rest/data/file/30/content
1099+
{
1100+
"data": {
1101+
"id": "30",
1102+
"type": "<class 'str'>",
1103+
"link": "https://tracker.example.com/demo/rest/data/file/30/content",
1104+
"data": "hello3",
1105+
"@etag": "\"3f2f8063dbce5b6bd43567e6f4f3c671\""
1106+
}
1107+
}
11091108

11101109
using the etag, overwrite the content with::
11111110

@@ -1254,11 +1253,12 @@ Examples of adding to your schema
12541253

12551254
Some examples are in the :ref:`CustomExamples` section below.
12561255

1257-
Also the `Roundup wiki`_ has additional examples of how schemas can be
1258-
customised to add new functionality.
1256+
Also you can start with `Roundup wiki CategorySchema`_ to see a list
1257+
of additional examples of how schemas can be customised to add new
1258+
functionality.
12591259

1260-
.. _Roundup wiki:
1261-
https://wiki.roundup-tracker.org/
1260+
.. _Roundup wiki CategorySchema:
1261+
https://wiki.roundup-tracker.org/CategorySchema
12621262

12631263
.. index:: !detectors
12641264
.. _detectors:
@@ -1389,7 +1389,7 @@ to use one, copy it to the ``'detectors'`` of your tracker instance:
13891389
The reason for this is that Microsoft Internet Explorer will not open
13901390
things with a .eml attachment, as they deem it 'unsafe'. Worse yet,
13911391
they'll just give you an incomprehensible error message. For more
1392-
information, see the detector code - it has a length explanation.
1392+
information, see the detector code - it has a lengthy explanation.
13931393

13941394

13951395
.. index:: auditors; rules for use

0 commit comments

Comments
 (0)