Skip to content

Commit 77888a1

Browse files
committed
docs: cleanups suggested by vale.
1 parent 6354620 commit 77888a1

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

doc/user_guide.txt

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,23 @@ User Guide
2020
Your Tracker in a Nutshell
2121
==========================
2222

23-
Your tracker holds information about issues in bundles we call *items*.
24-
An item may be an *issue* (a bug or feature request) or a *user*. The
25-
issue-ness or user-ness is called the item's *class*. So, for bug
23+
Your tracker holds information about issues in bundles called *items*.
24+
An item can be an *issue* (a bug or feature request) or a *user*. The
25+
issue-ness or user-ness is called the item's *class*. For bug
2626
reports and features, the class is "issue", and for users the class is
2727
"user".
2828

29-
Each item in the tracker has an ID number that identifies it along with
30-
its item class. To identify a particular issue or user, we combine the
31-
class with the number to create a unique label, so that user 1 (who,
32-
incidentally, is *always* the "admin" user) is referred to as "user1".
33-
Issue number 315 is referred to as "issue315". We call that label the
34-
item's :term:`designator`.
35-
36-
Items in the database are never deleted, they're just "retired". You
37-
can still refer to them by ID - hence removing an item won't break
38-
references to the item. It's just that the item won't appear in any
39-
listings.
29+
Each item in the tracker possesses an ID number that identifies it
30+
alongside its item class. The combination of the class and ID number
31+
into a label identifies a specific issue or user. For instance, user 1
32+
(who, by the way, always serves as the "admin" user) gets referred to
33+
as "user1". Issue number 315 gets denoted as "issue315". This label
34+
receives the designation of the item's :term:designator.
4035

36+
Roundup never deletes items from the database. Instead, items get
37+
"retired". Viewing the item using its ID is still possible - thus,
38+
"removing" an item does not disrupt references to it. A retired item
39+
will not appear in the class listing.
4140

4241
Accessing the Tracker
4342
---------------------
@@ -58,11 +57,12 @@ Issue life cycles in Roundup
5857

5958
New issues may be submitted via the web or e-mail.
6059

61-
By default, the issue will have the status "unread". If another message
62-
is received for the issue, its status will change to "chatting".
60+
By default, the issue will have the status "unread". When the issue
61+
receives another message, its status will change to "chatting".
6362

64-
The "home" page for a tracker will generally display all issues which
65-
are not "resolved".
63+
Often, the "home" page for a tracker display all open issues (closed
64+
issues have a status of resolved, or done-cbb (cbb - could be
65+
better)).
6666

6767
If an issue is closed, and a new message is received then it'll be
6868
reopened to the state of "chatting".
@@ -101,6 +101,8 @@ The full set of **priority** and **status** values are:
101101
"resolved" fix has been released
102102
============= =====================================
103103

104+
The tracker you are using may have different priorities and
105+
statuses. See your tracker admin for local details.
104106

105107
.. _query-tracker:
106108

@@ -112,11 +114,10 @@ This means the web interface for entering a new issue, the web interface
112114
for searching issues, the e-mail interface and even the command-line
113115
administration tool.
114116

115-
116117
String and Numeric properties
117118
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
118119

119-
These fields just take a simple text value, like ``It's broken``.
120+
These fields just take a plain text value, like ``It's broken``.
120121

121122

122123
Boolean properties

0 commit comments

Comments
 (0)