Mercurial > p > roundup > code

annotate doc/glossary.txt @ 6238:6834bb5473da

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Summary: Constrain format of classname and document Define the format of a valid classname. Updated design doc, function doc and glossary to document format. Error message for case where we have a redefinition of a classname now says why ValueError is raised since we are raising ValueError for incorrect classname format as well. Tests for all cases including verification of cause for ValueError exceptions.
author John Rouillard <rouilj@ieee.org>
date Tue, 28 Jul 2020 06:24:39 -0400
parents 25fcb87a8301
children 98e2835b787a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 ================
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 Roundup Glossary
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 ================
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 class
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
7 a definition of the properties and behaviour of a set of items
6238
6834bb5473da Summary: Constrain format of classname and document
John Rouillard <rouilj@ieee.org>
parents: 4746
diff changeset
8 classname
6834bb5473da Summary: Constrain format of classname and document
John Rouillard <rouilj@ieee.org>
parents: 4746
diff changeset
9 the name of a class. It must start with a letter, end with a letter
6834bb5473da Summary: Constrain format of classname and document
John Rouillard <rouilj@ieee.org>
parents: 4746
diff changeset
10 or "_", and only have alphanumerics and "_" in the middle.
1571
8b5ff6ca0674 more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
11 db (or hyperdb)
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
12 a collection of items
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 designator
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
14 a combined class + itemid reference to any item in the hyperdb
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
15 itemid
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
16 a numeric reference to a particular item of one class
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
17 item
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 a collection of data that forms one entry in the hyperdb.
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 property
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4557
diff changeset
20 one element of data that makes up an item. In Roundup, the set
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4557
diff changeset
21 of item properties may be changed as needed - even after the
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4557
diff changeset
22 tracker has been initialised and used in production.
796
5324a28060ab *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 783
diff changeset
23 schema
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
24 the definition of all the classes that make up an tracker
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
25 tracker
1571
8b5ff6ca0674 more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
26 the schema and hyperdb that forms one issue tracker
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
27 tracker home
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
28 the physical location on disk of a tracker
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 -----------------
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33 Back to `Table of Contents`_
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 .. _`Table of Contents`: index.html
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36
Roundup Issue Tracker: http://roundup-tracker.org/