From: richard <richard@57a73879-2fb5-44c3-a270-3262357dd7e2>
Date: Mon, 7 Dec 2009 00:33:39 +0000 (+0000)
Subject: include info on what a designator is in all commands that use them
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=985934a709c6321d1008b102a189bc01ae00a7ee;p=roundup.git

include info on what a designator is in all commands that use them

git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/roundup/trunk@4403 57a73879-2fb5-44c3-a270-3262357dd7e2
---

diff --git a/doc/upgrading.txt b/doc/upgrading.txt
index 70529d7..a5fe4e8 100644
--- a/doc/upgrading.txt
+++ b/doc/upgrading.txt
@@ -13,7 +13,7 @@ steps.
 
 .. contents::
 
-Migrating from 1.4.x to 1.4.10
+Migrating from 1.4.x to 1.4.11
 ==============================
 
 Grant the "Register" permission to the Anonymous role
diff --git a/roundup/admin.py b/roundup/admin.py
index 077a2f5..a8d75d1 100644
--- a/roundup/admin.py
+++ b/roundup/admin.py
@@ -523,6 +523,9 @@ Erase it? Y/N: """))
         ''"""Usage: get property designator[,designator]*
         Get the given property of one or more designator(s).
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         Retrieves the property value of the nodes specified
         by the designators.
         """
@@ -600,6 +603,9 @@ Erase it? Y/N: """))
         The items are specified as a class or as a comma-separated
         list of item designators (ie "designator[,designator,...]").
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         This command sets the properties to the values for all designators
         given. If the value is missing (ie. "property=") then the property
         is un-set. If the property is a multilink, you specify the linked
@@ -732,6 +738,9 @@ Erase it? Y/N: """))
         ''"""Usage: display designator[,designator]*
         Show the property values for the given node(s).
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         This lists the properties and their associated values for the given
         node.
         """
@@ -971,6 +980,9 @@ Erase it? Y/N: """))
         ''"""Usage: history designator
         Show the history entries of a designator.
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         Lists the journal entries for the node identified by the designator.
         """
         if len(args) < 1:
@@ -1020,6 +1032,9 @@ Erase it? Y/N: """))
         ''"""Usage: retire designator[,designator]*
         Retire the node specified by designator.
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         This action indicates that a particular node is not to be retrieved
         by the list or find commands, and its key value may be re-used.
         """
@@ -1044,6 +1059,9 @@ Erase it? Y/N: """))
         ''"""Usage: restore designator[,designator]*
         Restore the retired node specified by designator.
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         The given nodes will become available for users again.
         """
         if len(args) < 1: