DeepDiff 6 docs

Author: seperman

README.md

@@ -18,24 +18,13 @@ Tested on Python 3.6+ and PyPy3.
 
 ## What is new?
 
-DeepDiff 5-8-2
-Fixing dependency for Py3.6
+DeepDiff 6-0-0
 
-DeepDiff 5-8-1 includes bug fixes:
-- Fixed test suite for 32bit systems (https://github.com/seperman/deepdiff/issues/302) by [Louis-Philippe Véronneau](https://github.com/baldurmen)
-- Fixed the issue when using `ignore_order=True` and `group_by` simultaneously
-- Added the support for diffing object properties (`@property`) (https://github.com/seperman/deepdiff/issues/312)
-- Better support of diffing private variables
+- [Exclude obj callback strict](https://github.com/seperman/deepdiff/pull/320/files) parameter is added to DeepDiff by Mikhail Khviyuzov [mskhviyu](https://github.com/mskhviyu).
+- A fix for diffing using `iterable_compare_func` with nested objects by [dtorres-sf](https://github.com/dtorres-sf) who originally contributed this feature.
+- Temporarily we are publishing DeepDiff under `DeepDiff6` on pypi until further notice.
 
-DeepDiff 5-8-0 includes bug fixes and improvements:
-
-- Fixed the bug with delta randomly not producing the same results when `ignore_order=True` (https://github.com/seperman/deepdiff/issues/277)
-- Display detailed pretty when verbose by [Yael Mintz](https://github.com/yaelmi3)
-- Allow ordered-set version 4.1.x by [Tal Amuyal](https://github.com/TalAmuyal)
-- Removing extra logging when key is not found in DeepHash (https://github.com/seperman/deepdiff/issues/293)
-- Fixed error when comparing non-utf8 byte strings with ignore_order=True(https://github.com/seperman/deepdiff/issues/292)
-- Fixed Tests fail after 2022-05-14 (https://github.com/seperman/deepdiff/issues/255)
-- Fixed [TypeError is thrown when comparing bool and str](https://github.com/seperman/deepdiff/issues/275)
+Note: There are no breaking changes in DeepDiff 6 compared to the latest DeepDiff 5 releases.
 
 ## Installation
 
@@ -47,7 +36,10 @@ If you want to use DeepDiff from commandline:
 
 `pip install "deepdiff6[cli]"`
 
-> Note: prior to DeepDiff 6, we used `pip install deepdiff` to install DeepDiff. DeepDiff 6 is being published with a different package name on Pypi temporarily until further notice.
+
+> Note: Prior to DeepDiff 6, it was published under DeepDiff name on pypi.
+> DeepDiff 6 is being published under DeepDiff6 package name on Pypi temporarily until further notice.
+
 
 ### Importing
 

docs/diff_doc.rst

@@ -56,6 +56,10 @@ exclude_obj_callback: function, default = None
     A function that takes the object and its path and returns a Boolean. If True is returned, the object is excluded from the results, otherwise it is included.
     This is to give the user a higher level of control than one can achieve via exclude_paths, exclude_regex_paths or other means.
 
+exclude_obj_callback_strict: function, default = None
+    :ref:`exclude_obj_callback_strict_label`
+    A function that works the same way as exclude_obj_callback, but excludes elements from the result only if the function returns True for both elements
+
 get_deep_distance: Boolean, default = False
     :ref:`get_deep_distance_label` will get you the deep distance between objects. The distance is a number between 0 and 1 where zero means there is no diff between the 2 objects and 1 means they are very different. Note that this number should only be used to compare the similarity of 2 objects and nothing more. The algorithm for calculating this number may or may not change in the future releases of DeepDiff.
 

docs/ignore_types_or_values.rst

@@ -272,8 +272,14 @@ exclude_obj_callback: function, default = None
     >>> DeepDiff(t1, t2, exclude_obj_callback=exclude_obj_callback)
     {}
 
+
+.. _exclude_obj_callback_strict_label:
+
+Exclude Obj Callback Strict
+---------------------------
+
 exclude_obj_callback_strict: function, default = None
-    A function works the same way as exclude_obj_callback, but excludes elements from the result only if the function returns True for both elements
+    A function that works the same way as exclude_obj_callback, but excludes elements from the result only if the function returns True for both elements
 
     >>> def exclude_obj_callback_strict(obj, path):
     ...         return True if isinstance(obj, int) and obj > 10 else False

docs/index.rst

@@ -31,37 +31,18 @@ The DeepDiff library includes the following modules:
 What is New
 ***********
 
-DeepDiff 5-8-2
+DeepDiff 6-0-0
 --------------
+-  :ref:`exclude_obj_callback_strict_label`
+   parameter is added to DeepDiff by Mikhail Khviyuzov
+   `mskhviyu <https://github.com/mskhviyu>`__.
+-  A fix for diffing using ``iterable_compare_func`` with nested objects
+   by `dtorres-sf <https://github.com/dtorres-sf>`__ who originally
+   contributed this feature.
+-  Temporarily we are publishing DeepDiff under ``DeepDiff6`` on pypi
+   until further notice.
 
-Fixing dependency for Py3.6
-
-New In DeepDiff 5-8-1
----------------------
-
-DeepDiff 5-8-1 includes bug fixes: - Fixed test suite for 32bit systems
-(https://github.com/seperman/deepdiff/issues/302) by `Louis-Philippe
-Véronneau`_ - Fixed the issue when using ``ignore_order=True`` and
-``group_by`` simultaneously - Added the support for diffing object
-properties (``@property``)
-(https://github.com/seperman/deepdiff/issues/312) - Better support of
-diffing private variables
-
-.. _Louis-Philippe Véronneau: https://github.com/baldurmen
-
-New In DeepDiff 5-8-0
----------------------
-
-DeepDiff 5-8-0 includes bug fixes and improvements:
-
-- Fixed the bug with delta randomly not producing the same results when `ignore_order=True`
-- Display detailed pretty when verbose
-- Allow ordered-set version 4.1.x
-- Removing extra logging when key is not found in DeepHash
-- Fixed error when comparing non-utf8 byte strings with ignore_order=True
-- Fixed Tests fail after 2022-05-14
-- Fixed TypeError is thrown when comparing bool and str
-
+Note: There are no breaking changes in DeepDiff 6 compared to the latest DeepDiff 5 releases.
 
 *********
 Tutorials
@@ -83,8 +64,9 @@ If you want to use DeepDiff from commandline::
 
 Read about DeepDiff optimizations at :ref:`optimizations_label`
 
-Note: prior to DeepDiff 6, we used pip install deepdiff to install DeepDiff::
-    DeepDiff 6 is being published with a different package name on Pypi temporarily until further notice.
+.. note:: Prior to DeepDiff 6, it was published under DeepDiff name on pypi.
+
+    DeepDiff 6 is being published under DeepDiff6 package name on Pypi temporarily until further notice.
 
 
 Importing
@@ -99,7 +81,7 @@ Importing
     >>> from deepdiff import extract  # For extracting a path from an object
 
 
-Note: if you want to use DeepDiff via commandline, make sure to run:: 
+.. note:: if you want to use DeepDiff via commandline, make sure to run:: 
     pip install "deepdiff6[cli]"
 
 Then you can access the commands via: