Skip to content

Commit f74deec

Browse files
committed
docs: clarify wording, fix index, add superseder link
Make superseder, messages etc. properties index entries point to the right place. Link to description of using Superseder in the original overview. fix bad wording on boolean properties.
1 parent 84fd9af commit f74deec

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

doc/reference.txt

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -744,6 +744,11 @@ create(information)
744744
Create an item in the database. This is used to create items
745745
in the :term:`definitional class` like "priority" and "status".
746746

747+
.. index:: triple: schema; class property; messages
748+
triple: schema; class property; files
749+
triple: schema; class property; nosy
750+
triple: schema; class property; superseder
751+
747752
IssueClass
748753
~~~~~~~~~~
749754

@@ -756,6 +761,8 @@ users to tell about changes to the issue. They get "CC'ed"
756761
e-mails when messages are sent to or generated by the issue. The nosy
757762
reactor (in the ``'detectors'`` directory) handles this action. The
758763
superseder link indicates an issue which has superseded this one.
764+
It is better described in the
765+
`original document <original_overview.html#roundupdb>`_.
759766

760767
They also have the default "creation", "activity" and "creator"
761768
properties.
@@ -855,11 +862,6 @@ file class allows for other possibilities including:
855862
done on the filesystem outside of the Roundup mechanism.
856863
* keeping multiple revisions of the file.
857864

858-
.. index:: triple: schema; class property; messages
859-
triple: schema; class property; files
860-
triple: schema; class property; nosy
861-
triple: schema; class property; superseder
862-
863865
.. index:: schema; item ordering
864866

865867
A note about ordering
@@ -3084,7 +3086,7 @@ There are several methods available on these wrapper objects:
30843086
Set the labels for the true/false/undefined
30853087
states. If u_label is defined, it produces a
30863088
tri-state radio button selector. Otherwise, it
3087-
allows selection of true,yes/false,no only.
3089+
allows selection of true/yes or false/no only.
30883090

30893091
labelfirst (Boolean properties only)
30903092
place the labels before the radio buttons

0 commit comments

Comments
 (0)