Anatoly Pulyaevskiy il y a 4 ans
Parent
révision
cdc2a622b9
2 fichiers modifiés avec 5 ajouts et 16 suppressions
  1. 3
    7
      doc/concepts/data-and-document.md
  2. 2
    9
      doc/concepts/heuristics.md

+ 3
- 7
doc/concepts/data-and-document.md Voir le fichier

@@ -91,13 +91,9 @@ for more details.
91 91
 Notus documents are represented as a tree of nodes. There are 3 main
92 92
 types of nodes:
93 93
 
94
-* `LeafNode` - a leaf node which represents a segment of styled text
95
-  within a document. There are two kinds of leaf nodes - text and
96
-  embeds.
97
-* `LineNode` - represents an individual line of text within a document.
98
-  Line nodes are containers for leaf nodes.
99
-* `Block` - represents a group of adjacent lines which share the same
100
-  style. Examples of blocks include lists, quotes or code blocks.
94
+* `LeafNode` - a leaf node which represents a segment of styled text within a document. There are two kinds of leaf nodes - text and embeds.
95
+* `LineNode` - represents an individual line of text within a document. Line nodes are containers for leaf nodes.
96
+* `Block` - represents a group of adjacent lines which share the same style. Examples of blocks include lists, quotes or code blocks.
101 97
 
102 98
 Given above description, here is ASCII-style visualization of a Notus
103 99
 document tree:

+ 2
- 9
doc/concepts/heuristics.md Voir le fichier

@@ -72,15 +72,8 @@ conforms to the document model and data format semantics.
72 72
 
73 73
 This method exists mostly to enable following use cases:
74 74
 
75
-* **Collaborative editing**, when a change came from a different site and
76
-  has already been normalized by heuristic rules on that site. Care must
77
-  be taken to ensure that this change is based on the same revision
78
-  of the document, and if not, transformed against any local changes
79
-  before composing.
80
-* **Change history and revisioning**, when a change came from a revision
81
-  history stored on a server or a database. Similarly, care must be
82
-  taken to transform the change against any local (uncommitted) changes
83
-  before composing.
75
+* **Collaborative editing**, when a change came from a different site and has already been normalized by heuristic rules on that site. Care must be taken to ensure that this change is based on the same revision of the document, and if not, transformed against any local changes before composing.
76
+* **Change history and revisioning**, when a change came from a revision history stored on a server or a database. Similarly, care must be taken to transform the change against any local (uncommitted) changes before composing.
84 77
 
85 78
 When composing a change which came from a different site or server make
86 79
 sure to use `ChangeSource.remote` when calling `compose()`. This allows