Skip to content

Add core engine section in docs and rename example directories #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
Oct 19, 2021
Merged

Add core engine section in docs and rename example directories #72

Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
b2d92db
Add core engine section in docs and rename example directories
dgarros Oct 11, 2021
6ef651c
Update docs/source/core_engine/01-flags.md
dgarros Oct 13, 2021
93e36b4
Update docs/source/core_engine/02-customize-diff-class.md
dgarros Oct 13, 2021
4b76360
Update docs/source/core_engine/01-flags.md
dgarros Oct 13, 2021
827cefc
Update docs/source/core_engine/02-customize-diff-class.md
dgarros Oct 13, 2021
f29a4fd
Fix example directory names in unit tests
dgarros Oct 15, 2021
7ab6a00
Add skip state
dgarros Oct 15, 2021
81d6838
Fix pylint
dgarros Oct 18, 2021
54f6b3b
Update docs/source/core_engine/01-flags.md
dgarros Oct 18, 2021
6b13497
Update docs/source/core_engine/01-flags.md
dgarros Oct 18, 2021
d2bbd57
Update docs/source/core_engine/01-flags.md
dgarros Oct 18, 2021
54839fe
Update docs/source/core_engine/02-customize-diff-class.md
dgarros Oct 18, 2021
c28f405
Update docs/source/core_engine/01-flags.md
dgarros Oct 18, 2021
503a751
Update docs/source/core_engine/01-flags.md
dgarros Oct 18, 2021
6e38ea1
Remove Change the rendering of the result of the diff section from doc
dgarros Oct 18, 2021
aa88e88
Convert link to ReST format
dgarros Oct 18, 2021
6591f73
Update docs/source/core_engine/01-flags.md
dgarros Oct 19, 2021
a8e22a1
Update docs/source/core_engine/01-flags.md
dgarros Oct 19, 2021
066f742
Update docs/source/core_engine/01-flags.md
dgarros Oct 19, 2021
1566714
Update docs/source/core_engine/01-flags.md
dgarros Oct 19, 2021
8d937cc
Feedback from glenn
dgarros Oct 19, 2021
f17b2f5
Merge pull request #71 from networktocode/dga-update-doc
dgarros Oct 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update docs/source/core_engine/01-flags.md 
Co-authored-by: Glenn Matthews <[email protected]>
  • Loading branch information
@dgarros @glennmatthews
dgarros and glennmatthews authored Oct 19, 2021
commit 6591f73d1e15f5f70631c2a17317d78bba282aa2
12 changes: 7 additions & 5 deletions docs/source/core_engine/01-flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,16 @@ Enabling a flag is possible with the bitwise OR operator `|=`. It's important to

```python
>>> from diffsync.enum import DiffSyncFlags
>>> flags = 0
>>> flags |= DiffSyncFlags.CONTINUE_ON_FAILURE
>>> bin(flags)
>>> flags = DiffSyncFlags.CONTINUE_ON_FAILURE
>>> flags
<DiffSyncFlags.CONTINUE_ON_FAILURE: 1>
>>> bin(flags.value)
'0b1'
>>> flags |= DiffSyncFlags.SKIP_UNMATCHED_DST
>>> bin(flags)
>>> flags
<DiffSyncFlags.SKIP_UNMATCHED_DST|CONTINUE_ON_FAILURE: 5>
>>> bin(flags.value)
'0b101'
# Both CONTINUE_ON_FAILURE and SKIP_UNMATCHED_DST flags have been enabled
```

### Checking the value of a specific flag (bitwise AND)
Expand Down