updating docs

Author: seperman

README.md

@@ -130,7 +130,7 @@ And if you don't care about the value of items that have changed type, please se
 ```python
 >>> t1 = {1:1, 2:2, 3:3}
 >>> t2 = {1:1, 2:"2", 3:3}
->>> pprint(DeepDiff(t1, t2), indent=2)
+>>> pprint(DeepDiff(t1, t2, verbose_level=0), indent=2)
 { 'type_changes': { 'root[2]': { 'new_type': <class 'str'>,
                                  'old_type': <class 'int'>,}}}
 ```
@@ -381,8 +381,9 @@ And here is more info: <http://zepworks.com/blog/diff-it-to-digg-it/>
 
 ##Changelog
 
-- v1-8-0: Exclusion patterns
-- v1-7-0: Deep Set comparison
+- v2-0-0: Exclusion patterns better coverage. Updating docs.
+- v1-8-0: Exclusion patterns.
+- v1-7-0: Deep Set comparison.
 - v1-6-0: Unifying key names. i.e newvalue is new_value now. For backward compatibility, newvalue still works.
 - v1-5-0: Fixing ignore order containers with unordered items. Adding significant digits when comparing decimals. Changes property is deprecated.
 - v1-1-0: Changing Set, Dictionary and Object Attribute Add/Removal to be reported as Set instead of List. Adding Pypy compatibility.

README.txt

@@ -4,15 +4,6 @@ Deep Difference of dictionaries, iterables, strings and other objects. It will r
 
 Tested on Python 2.7, 3.3, 3.4, 3.5, Pypy, Pypy3
 
-**Pycon 2016**
-
-I was honored to give a talk about how DeepDiff does what it does at Pycon 2016. Please check out the video and let me know what you think:
-
-Diff It To Dig It Video
-https://www.youtube.com/watch?v=J5r99eJIxF4
-And here is more info:
-http://zepworks.com/blog/diff-it-to-digg-it/
-
 **Parameters**
 
 In addition to the 2 objects being compared:
@@ -220,11 +211,21 @@ Example in DeepDiff for the same operation:
     >>> DeepDiff(item1, item2)
     {'type_changes': {"root['a']['b']['c']": {'old_type': <type 'str'>, 'new_value': 42, 'old_value': 'foo', 'new_type': <type '
 
+**Pycon 2016**
+
+I was honored to give a talk about how DeepDiff does what it does at Pycon 2016. Please check out the video and let me know what you think:
+
+Diff It To Dig It Video
+https://www.youtube.com/watch?v=J5r99eJIxF4
+And here is more info:
+http://zepworks.com/blog/diff-it-to-digg-it/
+
 
 **Changelog**
 
-- v1-8-0: Exclusion patterns
-- v1-7-0: Deep Set comparison
+- v2-0-0: Exclusion patterns better coverage. Updating docs.
+- v1-8-0: Exclusion patterns.
+- v1-7-0: Deep Set comparison.
 - v1-6-0: Unifying key names. i.e newvalue is new_value now. For backward compatibility, newvalue still works.
 - v1-5-0: Fixing ignore order containers with unordered items. Adding significant digits when comparing decimals. Changes property is deprecated.
 - v1-1-0: Changing Set, Dictionary and Object Attribute Add/Removal to be reported as Set instead of List. Adding Pypy compatibility.

deepdiff/deepdiff.py

@@ -105,17 +105,11 @@ def __getitem__(self, old_key):
 class DeepDiff(RemapDict):
 
     r"""
-    **DeepDiff v 1.7.0**
+    **DeepDiff**
 
     Deep Difference of dictionaries, iterables, strings and almost any other object.
     It will recursively look for all the changes.
 
-    **Pycon 2016 Talk**
-    I gave a talk about how DeepDiff does what it does at Pycon 2016.
-    `Diff it to Dig it Pycon 2016 video <https://www.youtube.com/watch?v=J5r99eJIxF4>`_
-
-    And here is more info: http://zepworks.com/blog/diff-it-to-digg-it/
-
     **Parameters**
 
     t1 : A dictionary, list, string or any python object that has __dict__ or __slots__
@@ -157,6 +151,12 @@ class DeepDiff(RemapDict):
 
     int, string, unicode, dictionary, list, tuple, set, frozenset, OrderedDict, NamedTuple and custom objects!
 
+    **Pycon 2016 Talk**
+    I gave a talk about how DeepDiff does what it does at Pycon 2016.
+    `Diff it to Dig it Pycon 2016 video <https://www.youtube.com/watch?v=J5r99eJIxF4>`_
+
+    And here is more info: http://zepworks.com/blog/diff-it-to-digg-it/
+
     **Examples**
 
     Importing
@@ -182,17 +182,24 @@ class DeepDiff(RemapDict):
     Value of an item has changed
         >>> t1 = {1:1, 2:2, 3:3}
         >>> t2 = {1:1, 2:4, 3:3}
-        >>> pprint(DeepDiff(t1, t2), indent=2)
+        >>> pprint(DeepDiff(t1, t2, verbose_level=0), indent=2)
         {'values_changed': {'root[2]': {'new_value': 4, 'old_value': 2}}}
 
     Item added and/or removed
-        >>> t1 = {1:1, 2:2, 3:3, 4:4}
-        >>> t2 = {1:1, 2:4, 3:3, 5:5, 6:6}
+        >>> t1 = {1:1, 3:3, 4:4}
+        >>> t2 = {1:1, 3:3, 5:5, 6:6}
         >>> ddiff = DeepDiff(t1, t2)
         >>> pprint (ddiff)
         {'dictionary_item_added': {'root[5]', 'root[6]'},
-         'dictionary_item_removed': {'root[4]'},
-         'values_changed': {'root[2]': {'new_value': 4, 'old_value': 2}}}
+         'dictionary_item_removed': {'root[4]'}}
+
+    Set verbose level to 2 in order to see the added or removed items with their values
+        >>> t1 = {1:1, 3:3, 4:4}
+        >>> t2 = {1:1, 3:3, 5:5, 6:6}
+        >>> ddiff = DeepDiff(t1, t2, verbose_level=2)
+        >>> pprint(ddiff, indent=2)
+        { 'dictionary_item_added': {'root[5]': 5, 'root[6]': 6},
+          'dictionary_item_removed': {'root[4]': 4}}
 
     String difference
         >>> t1 = {1:1, 2:2, 3:3, 4:{"a":"hello", "b":"world"}}
@@ -247,6 +254,13 @@ class DeepDiff(RemapDict):
                                               'old_type': <class 'list'>,
                                               'old_value': [1, 2, 3]}}}
 
+    And if you don't care about the value of items that have changed type, please set verbose level to 0
+        >>> t1 = {1:1, 2:2, 3:3}
+        >>> t2 = {1:1, 2:"2", 3:3}
+        >>> pprint(DeepDiff(t1, t2, verbose_level=0), indent=2)
+        { 'type_changes': { 'root[2]': { 'new_type': <class 'str'>,
+                                         'old_type': <class 'int'>}}}
+
     List difference
         >>> t1 = {1:1, 2:2, 3:3, 4:{"a":"hello", "b":[1, 2, 3, 4]}}
         >>> t2 = {1:1, 2:2, 3:3, 4:{"a":"hello", "b":[1, 2]}}

docs/index.rst

@@ -20,7 +20,7 @@ Install from PyPi::
 
 
 **************
-DeepDiff 1.7.0
+DeepDiff 2.0.0
 **************
 
 .. toctree::
@@ -44,7 +44,9 @@ Indices and tables
 Changelog
 =========
 
-- v1-7-0: Deep Set comparison
+- v2-0-0: Exclusion patterns better coverage. Updating docs.
+- v1-8-0: Exclusion patterns.
+- v1-7-0: Deep Set comparison.
 - v1-6-0: Unifying key names. i.e newvalue is new_value now. For backward compatibility, newvalue still works.
 - v1-5-0: Fixing ignore order containers with unordered items. Adding significant digits when comparing decimals. Changes property is deprecated.
 - v1-1-0: Changing Set, Dictionary and Object Attribute Add/Removal to be reported as Set instead of List. Adding Pypy compatibility.