8000 Update docs/source/core_engine/02-customize-diff-class.md · networktocode/diffsync@fc611ab · GitHub
[go: up one dir, main page]

Skip to content

Commit fc611ab

Browse files
Update docs/source/core_engine/02-customize-diff-class.md
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
1 parent de43225 commit fc611ab

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/source/core_engine/02-customize-diff-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class MyDiff(Diff):
3333

3434
## Change the order in which the element are being processed
3535

36-
By default, all objects of the same type will be stored in a dictionary and as such the order in which they will be processed during a diff or a sync operation is not guarantee. When the order in which a given group of object should be processed is important, it's possible to define your own ordering inside a custom Diff class.
36+
By default, all objects of the same type will be stored in a dictionary and as such the order in which they will be processed during a diff or a sync operation is not guaranteed (although in most cases, it will match the order in which they were initially loaded and added to the adapter). When the order in which a given group of object should be processed is important, it's possible to define your own ordering inside a custom Diff class.
3737

3838
When iterating over a list of objects, either at the top level or as a group of children of a given object, the core engine is looking for a function named after the type of the object `order_children_<type>` and if none is found it will rely on the default function `order_children_default`. Either function need to be present and need to return an Iterator of DiffElement.
3939

0 commit comments

Comments
 (0)
0