Mercurial > p > roundup > code
changeset 4567:32b24abfe98e
Documentation polishing.
| author | Eric S. Raymond <esr@thyrsus.com> |
|---|---|
| date | Tue, 15 Nov 2011 18:35:54 -0500 |
| parents | b8119ba37707 |
| children | 4604ace31669 |
| files | doc/FAQ.txt doc/admin_guide.txt doc/announcement.txt doc/design.txt doc/glossary.txt doc/security.txt |
| diffstat | 6 files changed, 12 insertions(+), 12 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/FAQ.txt Sun Nov 13 11:18:42 2011 -0500 +++ b/doc/FAQ.txt Tue Nov 15 18:35:54 2011 -0500 @@ -161,7 +161,7 @@ Great! But now the select/option list is too big ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Thats a little harder (but only a little ;^) +That is a little harder (but only a little ;^) Again, edit ``html/issue.item``. For nosy, change line (around line 69) from:: @@ -177,8 +177,8 @@ Using Roundup ------------- -I got an error and I cant reload it! -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +I got an error and I cannot reload it! +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you're using Netscape/Mozilla, try holding shift and pressing reload. If you're using IE then install Mozilla and try again ;^)
--- a/doc/admin_guide.txt Sun Nov 13 11:18:42 2011 -0500 +++ b/doc/admin_guide.txt Tue Nov 15 18:35:54 2011 -0500 @@ -243,7 +243,7 @@ roundup-admin -i <tracker home> import <tracker export dir> - If interactively, enter 'commit' before exitting. + If interactively, enter 'commit' before exiting. 7. Test each of the admin tool, web interface and mail gateway using the new backend. 8. Move the old tracker home out of the way (rename to "tracker.old") and
--- a/doc/announcement.txt Sun Nov 13 11:18:42 2011 -0500 +++ b/doc/announcement.txt Tue Nov 15 18:35:54 2011 -0500 @@ -14,7 +14,7 @@ Fixed: -- Installation: Fixed an issue that prevented to use EasyInstall +- Installation: Fixed an issue that prevented use of EasyInstall and a Python egg. Thanks to Satchidanand Haridas for the patch and John Kristensen for testing it. (Bernhard Reiter) - The PostgreSQL backend quotes database names now for CREATE and DROP,
--- a/doc/design.txt Sun Nov 13 11:18:42 2011 -0500 +++ b/doc/design.txt Tue Nov 15 18:35:54 2011 -0500 @@ -23,7 +23,7 @@ ----------------- Lots of software design documents come with a picture of a cake. -Everybody seems to like them. I also like cakes (i think they are +Everybody seems to like them. I also like cakes (I think they are tasty). So I, too, shall include a picture of a cake here:: ________________________________________________________________ @@ -68,7 +68,7 @@ representing date-and-time stamps and Interval objects for representing date-and-time intervals. -As strings, date-and-time stamps are specified with the date in +As strings, date-and-time stamps are specified with the date in ISO8601 international standard format (``yyyy-mm-dd``) joined to the time (``hh:mm:ss``) by a period "``.``". Dates in this form can be easily compared and are fairly readable when printed. An example of a valid @@ -457,7 +457,7 @@ given items. 'propspec' consists of keyword args propname=itemid or - propname={<itemid 1>:1, <itemid 2>: 1, ...} + propname={<itemid 1>:1, <itemid 2>:1, ...} 'propname' must be the name of a property in this class, or a KeyError is raised. That property must be a Link or Multilink property, or a TypeError
--- a/doc/glossary.txt Sun Nov 13 11:18:42 2011 -0500 +++ b/doc/glossary.txt Tue Nov 15 18:35:54 2011 -0500 @@ -16,9 +16,9 @@ item a collection of data that forms one entry in the hyperdb. property - one element of data that makes up an item. In Roundup, item - properties may be changed as needed - even after the tracker - has been initialised and used in production. + one element of data that makes up an item. In Roundup, the set + of item properties may be changed as needed - even after the + tracker has been initialised and used in production. schema the definition of all the classes that make up an tracker tracker
--- a/doc/security.txt Sun Nov 13 11:18:42 2011 -0500 +++ b/doc/security.txt Tue Nov 15 18:35:54 2011 -0500 @@ -56,7 +56,7 @@ 3) at a logical permission level, checked as needed. In all cases, the security built into roundup assumes restricted access to the -hyperdatabase itself, through Operating System controls such as user or group +hyperdatabase itself, through operating-system controls such as user or group permissions.