Skip to content

Commit 8d937cc

Browse files
committed
Feedback from glenn
1 parent 1566714 commit 8d937cc

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

docs/source/core_engine/01-flags.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11

2-
The core engine of DiffSync is meant to be transparent for most users but in some cases it's important to have the ability to change its behavior to adjust to some specific use cases. For these use cases, there are several ways to customize its behavior:
3-
- Global and Model Flags
4-
- Diff class
5-
62
# Global and Model Flags
73

84
These flags offer a powerful way to instruct the core engine how to handle some specific situation without changing the data. One way to think of the flags is to represent them as configuration for the core engine. Currently 2 sets of flags are supported:
@@ -64,7 +60,7 @@ class MyAdapter(DiffSync):
6460

6561
## Working with flags
6662

67-
Flags are stored in binary format. In binary format, each bit of a variable represents 1 flag which allow us to have up to 64 flags stored in a single variable. Using binary flags provides more flexibility to add support for more flags in the future without redefining the current interfaces and the current DiffSync API.
63+
Flags are stored in binary format. In binary format, each bit of a variable represents 1 flag which allow us to have up to many flags stored in a single variable. Using binary flags provides more flexibility to add support for more flags in the future without redefining the current interfaces and the current DiffSync API.
6864

6965
### Enable a flag (Bitwise OR)
7066

docs/source/core_engine/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
###############
21
Core Engine
3-
###############
2+
===========
43

4+
The core engine of DiffSync is meant to be transparent for most users but in some cases it's important to have the ability to change its behavior to adjust to some specific use cases. For these use cases, there are several ways to customize its behavior:
5+
6+
- Global and Model Flags
7+
- Diff class
58

69
.. mdinclude:: 01-flags.md
710
.. mdinclude:: 02-customize-diff-class.md

0 commit comments

Comments
 (0)