[Checkins] SVN: zc.relationship/trunk/src/zc/relationship/ Some typo and ReStructuredText formatting fixes.

Marius Gedminas marius at pov.lt
Tue May 23 12:23:40 EDT 2006


Log message for revision 68256:
  Some typo and ReStructuredText formatting fixes.
  
  

Changed:
  U   zc.relationship/trunk/src/zc/relationship/README.txt
  U   zc.relationship/trunk/src/zc/relationship/container.txt

-=-
Modified: zc.relationship/trunk/src/zc/relationship/README.txt
===================================================================
--- zc.relationship/trunk/src/zc/relationship/README.txt	2006-05-23 16:23:15 UTC (rev 68255)
+++ zc.relationship/trunk/src/zc/relationship/README.txt	2006-05-23 16:23:39 UTC (rev 68256)
@@ -599,7 +599,7 @@
     [(<(<Person 'Fred'>,) has the role of (<Role 'Project Manager'>,)>,)]
 
 `isLinked` returns a boolean if there is at least one path that matches the
-search--in fact, the implementation is essentially
+search--in fact, the implementation is essentially ::
 
     try:
         iter(ix.findRelationshipTokenChains(...args...)).next()
@@ -679,7 +679,7 @@
 It's possible to do transitive searches as well.  This can let you find all
 transitive bosses, or transitive subordinates, in our 'manages' relationship
 type.  Let's set up some example relationships.  Using letters to represent our
-people, we'll create three heirarchies like this:
+people, we'll create three hierarchies like this::
 
         A        JK           R
        / \      /  \           
@@ -884,14 +884,14 @@
 Zane; and Emily teaches Mary the lessons of Ygritte.
 
 In the diagram, left-hand lines indicate "taught" and right-hand lines indicate
-"the lessons of", so 
+"the lessons of", so ::
 
   E   Y
    \ /
     M
 
 should be read as "Emily taught Mary the lessons of Ygritte".  Here's the full
-diagram:
+diagram::
 
             C   L
              \ /
@@ -1091,7 +1091,7 @@
 The index keeps track of this and stops right when the cycle happens, and right
 before the cycle duplicates any relationships.  It marks the chain that has
 cycle as a special kind of tuple that implements ICircularRelationshipPath.
-the tuple has a 'cycled' attribute that contains the one or more searches
+The tuple has a 'cycled' attribute that contains the one or more searches
 that would be equivalent to following the cycle (given the same transitiveMap).
 
 Let's actually look at the example we described.
@@ -1165,7 +1165,7 @@
 returns, which means that complex transitive behavior can be modeled.  For
 instance, imagine genealogical relationships.  Let's say the basic
 relationship is "MALE and FEMALE had CHILDREN".  Walking transitively to get
-ancestors or descendents would need to distinguish between male children and
+ancestors or descendants would need to distinguish between male children and
 female children in order to correctly generate the transitive search.  This
 could be accomplished by resolving each child token and examining the object
 or, probably more efficiently, getting an indexed collection of males and
@@ -1271,7 +1271,7 @@
 - have the returned value be of the same btree family as the result family.
 
 For some operations, particularly with hundreds or thousands of members in a
-single relationship value, some of these optimzations can speed up some
+single relationship value, some of these optimizations can speed up some
 common-case reindexing work by around 100 times.
 
 The easiest (and perhaps least useful) optimization is that all dump
@@ -1333,4 +1333,4 @@
     [2]
 
 Remember that BTrees (not just BTreeSets) can be used for these values: the keys
-are used as the values in that case.
\ No newline at end of file
+are used as the values in that case.

Modified: zc.relationship/trunk/src/zc/relationship/container.txt
===================================================================
--- zc.relationship/trunk/src/zc/relationship/container.txt	2006-05-23 16:23:15 UTC (rev 68255)
+++ zc.relationship/trunk/src/zc/relationship/container.txt	2006-05-23 16:23:39 UTC (rev 68256)
@@ -115,7 +115,7 @@
     ... # nothingness when _p_deactivate is called
 
 Now there are six direct relationships (all of the relationships point down
-in the diagram):
+in the diagram)::
 
         ob0
         | |\
@@ -540,7 +540,7 @@
 reindexed.  The default implementation of the relationship objects calls this
 automatically when sources and targets are changed.
 
-To reiterate, the relationships looked like this before.
+To reiterate, the relationships looked like this before. ::
 
         ob0
         | |\
@@ -550,7 +550,7 @@
       |
     ob5
 
-We'll switch out ob3 and ob4, so the diagram looks like this.
+We'll switch out ob3 and ob4, so the diagram looks like this. ::
 
         ob0
         | |\
@@ -585,7 +585,7 @@
     ['ob0', 'ob1']
 
 The same sort of thing happens if we change sources.  We'll change the
-diagram to look like this.
+diagram to look like this. ::
 
         ob0
         | |\
@@ -630,7 +630,7 @@
 
 For instance, imagine that we change the relationships to look like the diagram
 below.  The `xxx` lines indicate a relationship that implements
-ISpecialRelationship.
+ISpecialRelationship. ::
 
         ob0
         x |x
@@ -783,7 +783,7 @@
 Relating Relationships and Relationship Containers
 --------------------------------------------------
 
-Relationships are objects.  We've already shown and discused how this means
+Relationships are objects.  We've already shown and discussed how this means
 that they can implement different interfaces and be annotated.  It also means
 that relationships are first-class objects that can be related themselves.
 This allows relationships that keep track of who created other relationships,
@@ -802,4 +802,4 @@
 
 The containers include three methods for these sorts of use cases:
 `findTargetTokens`, `findSourceTokens`, and `findRelationshipTokens`.  They
-take the same arguments as their simlarly-named cousins.
+take the same arguments as their similarly-named cousins.



More information about the Checkins mailing list