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 committed Oct 15, 2021
commit 4b76360225438b1b725e5e7ca6673c11c316b21f
2 changes: 1 addition & 1 deletion docs/source/core_engine/01-flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The core engine of DiffSync is meant to be transparent for most users but in som

The flags offers 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 set of flags are supported:
- **global flags**: applicable to all data.
- **model flags**: applicable to a single instance of a model.
- **model flags**: applicable to a specific model or to individual instances of a model.

> *The flags are stored in binary format which allow to store them in a single variable. See the section below [Working with flags](#working-with-flags) to learn how to manage them.*

Expand Down