Mercurial > p > roundup > code
comparison doc/design.txt @ 4567:32b24abfe98e
Documentation polishing.
| author | Eric S. Raymond <esr@thyrsus.com> |
|---|---|
| date | Tue, 15 Nov 2011 18:35:54 -0500 |
| parents | f4a863d88a99 |
| children | 0485b47a39a8 |
comparison
equal
deleted
inserted
replaced
| 4566:b8119ba37707 | 4567:32b24abfe98e |
|---|---|
| 21 | 21 |
| 22 The Layer Cake | 22 The Layer Cake |
| 23 ----------------- | 23 ----------------- |
| 24 | 24 |
| 25 Lots of software design documents come with a picture of a cake. | 25 Lots of software design documents come with a picture of a cake. |
| 26 Everybody seems to like them. I also like cakes (i think they are | 26 Everybody seems to like them. I also like cakes (I think they are |
| 27 tasty). So I, too, shall include a picture of a cake here:: | 27 tasty). So I, too, shall include a picture of a cake here:: |
| 28 | 28 |
| 29 ________________________________________________________________ | 29 ________________________________________________________________ |
| 30 | E-mail Client | Web Browser | Detector Scripts | Shell | | 30 | E-mail Client | Web Browser | Detector Scripts | Shell | |
| 31 |---------------+---------------+--------------------+-----------| | 31 |---------------+---------------+--------------------+-----------| |
| 66 Before we get into the hyperdatabase itself, we need a way of handling | 66 Before we get into the hyperdatabase itself, we need a way of handling |
| 67 dates. The hyperdatabase module provides Timestamp objects for | 67 dates. The hyperdatabase module provides Timestamp objects for |
| 68 representing date-and-time stamps and Interval objects for representing | 68 representing date-and-time stamps and Interval objects for representing |
| 69 date-and-time intervals. | 69 date-and-time intervals. |
| 70 | 70 |
| 71 As strings, date-and-time stamps are specified with the date in | 71 As strings, date-and-time stamps are specified with the date in ISO8601 |
| 72 international standard format (``yyyy-mm-dd``) joined to the time | 72 international standard format (``yyyy-mm-dd``) joined to the time |
| 73 (``hh:mm:ss``) by a period "``.``". Dates in this form can be easily | 73 (``hh:mm:ss``) by a period "``.``". Dates in this form can be easily |
| 74 compared and are fairly readable when printed. An example of a valid | 74 compared and are fairly readable when printed. An example of a valid |
| 75 stamp is "``2000-06-24.13:03:59``". We'll call this the "full date | 75 stamp is "``2000-06-24.13:03:59``". We'll call this the "full date |
| 76 format". When Timestamp objects are printed as strings, they appear in | 76 format". When Timestamp objects are printed as strings, they appear in |
| 455 def find(self, **propspec): | 455 def find(self, **propspec): |
| 456 """Get the ids of items in this class which link to the | 456 """Get the ids of items in this class which link to the |
| 457 given items. | 457 given items. |
| 458 | 458 |
| 459 'propspec' consists of keyword args propname=itemid or | 459 'propspec' consists of keyword args propname=itemid or |
| 460 propname={<itemid 1>:1, <itemid 2>: 1, ...} | 460 propname={<itemid 1>:1, <itemid 2>:1, ...} |
| 461 'propname' must be the name of a property in this class, | 461 'propname' must be the name of a property in this class, |
| 462 or a KeyError is raised. That property must | 462 or a KeyError is raised. That property must |
| 463 be a Link or Multilink property, or a TypeError | 463 be a Link or Multilink property, or a TypeError |
| 464 is raised. | 464 is raised. |
| 465 | 465 |