From 37b96114779e68cbf9da704c4799f9b98b0288fd Mon Sep 17 00:00:00 2001 From: Seperman Date: Thu, 31 Dec 2020 10:59:11 -0800 Subject: [PATCH] updating docs --- docs/conf.py | 2 +- docs/diff_doc.rst | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 03a2ee80..adfc01f2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,7 +52,7 @@ # General information about the project. project = 'DeepDiff' -copyright = '2015-2020, Sep Dehpour' +copyright = '2015-2021, Sep Dehpour' author = 'Sep Dehpour' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/diff_doc.rst b/docs/diff_doc.rst index 8b822d0d..50f1ffc0 100644 --- a/docs/diff_doc.rst +++ b/docs/diff_doc.rst @@ -52,6 +52,9 @@ exclude_obj_callback: function, default = None 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. +group_by: String, default=None + :ref:`group_by` can be used when dealing with list of dictionaries to convert them to group them by value defined in group_by. The common use case is when reading data from a flat CSV and primary key is one of the columns in the CSV. We want to use the primary key to group the rows instead of CSV row number. + hasher: default = DeepHash.murmur3_128bit Hash function to be used. If you don't want Murmur3, you can use Python's built-in hash function by passing hasher=hash. This is for advanced usage and normally you don't need to modify it.