Feature/dakonr dx sync to

[dakonr]

• resolves Update sync_from and sync_to to return the diff and the status of the sync #77 Improving the DX by returning the diff in the sync_to and sync_from methods.
• Added a "Raises" Paragraph to the docstring of sync_to and sync_from

[Kircheneer]

LGTM

[Kircheneer]

@dakonr please run black on the code and make sure the rest of the CI passes, then we're good to go. Thanks!

[dakonr]

sorry, there were still some blanks on init.py
should be fine now.

[Kircheneer]

CI is still complaining, pylint stage this time. You can run that locally with invoke pylint to make sure it passes.

[dakonr]

Hi, I had to move the pylint disable comment to the first line of the function definition (in the development branch it is still at the end).
As a new developer on the codebase I had no experience with invoke. All tasks at "invoke tests" passed on my local machine. I hope you had not that trouble with my contribution, I'm usually working with a GitLab CI toolchain.

[Kircheneer]

LGTM

[Kircheneer]

Hi, I had to move the pylint disable comment to the first line of the function definition (in the development branch it is still at the end). As a new developer on the codebase I had no experience with invoke. All tasks at "invoke tests" passed on my local machine. I hope you had not that trouble with my contribution, I'm usually working with a GitLab CI toolchain.

@dakonr absolutely no worries - I think discoverability of the invoke tasks for linting is a little lacking, I will add that to the README. Thanks for the contribution!