changeset 8264:09e8d1a4c796

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.
author John Rouillard <rouilj@ieee.org>
date Wed, 08 Jan 2025 11:39:54 -0500
parents 78b13272d41b
children 35beff316883
files doc/reference.txt
diffstat 1 files changed, 8 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/doc/reference.txt	Tue Jan 07 23:00:35 2025 -0500
+++ b/doc/reference.txt	Wed Jan 08 11:39:54 2025 -0500
@@ -744,6 +744,11 @@
 Create an item in the database. This is used to create items
 in the :term:`definitional class` like "priority" and "status".
 
+.. index:: triple: schema; class property; messages
+   triple: schema; class property; files
+   triple: schema; class property; nosy
+   triple: schema; class property; superseder
+
 IssueClass
 ~~~~~~~~~~
 
@@ -756,6 +761,8 @@
 e-mails when messages are sent to or generated by the issue. The nosy
 reactor (in the ``'detectors'`` directory) handles this action. The
 superseder link indicates an issue which has superseded this one.
+It is better described in the
+`original document <original_overview.html#roundupdb>`_.
 
 They also have the default "creation", "activity" and "creator"
 properties.
@@ -855,11 +862,6 @@
   done on the filesystem outside of the Roundup mechanism.
 * keeping multiple revisions of the file.
 
-.. index:: triple: schema; class property; messages
-   triple: schema; class property; files
-   triple: schema; class property; nosy
-   triple: schema; class property; superseder
-
 .. index:: schema; item ordering
 
 A note about ordering
@@ -3084,7 +3086,7 @@
 	        Set the labels for the true/false/undefined
 		states. If u_label is defined, it produces a
 	        tri-state radio button selector. Otherwise, it
-		allows selection of true,yes/false,no only.
+		allows selection of true/yes or false/no only.
 
 	      labelfirst (Boolean properties only)
 	        place the labels before the radio buttons

Roundup Issue Tracker: http://roundup-tracker.org/