Skip to content

Minor typo in custom.rst #428

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 1 commit into from
Nov 5, 2023
Merged

Minor typo in custom.rst #428

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/custom.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ To define an custom operator, you just need to inherit a *BaseOperator* and
* implement a give_up_diffing method
* give_up_diffing(level: DiffLevel, diff_instance: DeepDiff) -> boolean

If it returns True, then we will give up diffing the tow objects.
If it returns True, then we will give up diffing the two objects.
You may or may not use the diff_instance.custom_report_result within this function
to report any diff. If you decide not to report anything, and this
function returns True, then the objects are basically skipped in the results.
Expand Down