fixing doc errors

seperman · seperman · commit 4f6136859e77 · 2026-03-27T11:34:41.000-07:00
diff --git a/deepdiff/diff.py b/deepdiff/diff.py
@@ -430,10 +430,11 @@ def custom_report_result(self, report_type, level, extra_info=None):
         Add a detected change to the reference-style result dictionary.
         report_type will be added to level.
         (We'll create the text-style report from there later.)
+
         :param report_type: A well defined string key describing the type of change.
-                            Examples: "set_item_added", "values_changed"
+            Examples: "set_item_added", "values_changed"
         :param parent: A DiffLevel object describing the objects in question in their
-                       before-change and after-change object structure.
+            before-change and after-change object structure.
         :param extra_info: A dict that describe this result
         :rtype: None
         """
diff --git a/docs/_templates/basic/layout.html b/docs/_templates/basic/layout.html
diff --git a/docs/authors.rst b/docs/authors.rst
@@ -92,7 +92,7 @@ Authors in order of the timeline of their contributions:
 -  `dtorres-sf <https://github.com/dtorres-sf>`__ for fixing iterable
    moved items when iterable_compare_func is used.
 -  `Florian Finkernagel <https://github.com/TyberiusPrime>`__ for pandas
-and polars support.
+   and polars support.
 - Mathis Chenuet `artemisart <https://github.com/artemisart>`__ for
   fixing slots classes comparison and PR review.
 - Sherjeel Shabih `sherjeelshabih <https://github.com/sherjeelshabih>`__
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -69,7 +69,7 @@ DeepDiff Changelog
     - New summarization algorithm that produces valid json
     - Better type hint support
     - Breaking change in DeepHash where we raise Exception instead of logging if we can't hash a value.
-   - Added the log_stacktrace parameter to DeepDiff. When True, it will log the stacktrace along with the error.
+    - Added the log_stacktrace parameter to DeepDiff. When True, it will log the stacktrace along with the error.
 
 - v8-3-0
     - Fixed some static typing issues
diff --git a/docs/commandline.rst b/docs/commandline.rst
@@ -110,7 +110,7 @@ what if we assume last names are unique and group by last_name?
 The path is perhaps more readable now: `root['Molotov']['zip']`. It is more clear that the zip code of Molotov has changed.
 
 .. Note::
-    The parameters in the deep diff commandline are a subset of those in :ref:`deepdiff_module_label` 's Python API.
+    The parameters in the deep diff commandline are a subset of those in :ref:`deepdiff_label` 's Python API.
 
 To output in a specific format, for example the colored compact view (see :doc:`colored_view` for output details):
 
@@ -210,7 +210,7 @@ Run
 
 to get the options:
 
-.. code-block:: bash
+.. code-block:: text
 
     $ deep patch --help
     Usage: deep patch [OPTIONS] PATH DELTA_PATH
diff --git a/docs/deephash_doc.rst b/docs/deephash_doc.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 **DeepHash**
 
 DeepHash calculates the hash of objects based on their contents in a deterministic way.
diff --git a/docs/delta.rst b/docs/delta.rst
@@ -68,8 +68,10 @@ force : Boolean, default=False
 always_include_values : Boolean, default=False
     :ref:`always_include_values_label` is used to make sure the delta objects includes the values that were changed. Sometime Delta tries to be efficient not include the values when it can get away with it. By setting this parameter to True, you ensure that the Delta object will include the values.
 
+.. _delta_fill:
+
 fill : Any, default=No Fill
-    :ref:`delta_fill` This is only relevant if `force` is set. This parameter only applies when force is set and trying to fill an existing array. If the index of the array being applied is larger than the length of the array this value will be used to fill empty spaces of the array to extend it in order to add the new value. If this parameter is not set, the items will get dropped and the array not extended. If this parameter is set with a callable function, it will get called each time a fill item is needed. It will be provided with three arguments: first argument is the array being filled, second argument is the value that is being added to the array, the third argument is the path that is being added.
+    This is only relevant if `force` is set. This parameter only applies when force is set and trying to fill an existing array. If the index of the array being applied is larger than the length of the array this value will be used to fill empty spaces of the array to extend it in order to add the new value. If this parameter is not set, the items will get dropped and the array not extended. If this parameter is set with a callable function, it will get called each time a fill item is needed. It will be provided with three arguments: first argument is the array being filled, second argument is the value that is being added to the array, the third argument is the path that is being added.
     Example function: `def fill(obj, value, path): return "Camry" if "car" in path else None`
 
 
@@ -190,7 +192,7 @@ You can create a delta object from the list of flat dictionaries that are produc
 Flat Rows List
 --------------
 
-You can create a delta object from the list of flat dictionaries that are produced via :ref:`to_flat_rows_label`. Read more on :ref:`delta_from_flat_rows_label`.
+You can create a delta object from the list of flat dictionaries that are produced via :ref:`delta_to_flat_rows_label`. Read more on :ref:`delta_to_flat_rows_label`.
 
 
 .. _delta_deserializer_label:
diff --git a/docs/diff_doc.rst b/docs/diff_doc.rst
@@ -1,7 +1,7 @@
-.. _deepdiff_module_label:
+:orphan:
 
-DeepDiff
-========
+DeepDiff Module
+===============
 
 **DeepDiff is now part of** `Qluster <https://qluster.ai>`__.
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -133,7 +133,7 @@ If you want to improve the performance of DeepDiff with certain processes such a
 Read about DeepDiff optimizations at :ref:`optimizations_label`
 
 Importing
-~~~~~~~~~
+---------
 
 .. code:: python
 
@@ -144,8 +144,10 @@ 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:: 
-    pip install "deepdiff[cli]"
+.. note::
+    if you want to use DeepDiff via commandline, make sure to run::
+
+        pip install "deepdiff[cli]"
 
 Then you can access the commands via:
 
@@ -166,6 +168,7 @@ Then you can access the commands via:
 .. code:: bash
 
     $ deep grep --help
+
 - extract
 
 .. code:: bash
@@ -174,7 +177,7 @@ Then you can access the commands via:
 
 
 Supported data types
-~~~~~~~~~~~~~~~~~~~~
+--------------------
 
 int, string, unicode, dictionary, list, tuple, set, frozenset, OrderedDict, NamedTuple, Numpy, custom objects and more!
 
diff --git a/docs/numbers.rst b/docs/numbers.rst
@@ -172,7 +172,7 @@ use_log_scale: Boolean, default=False
 .. _log_scale_similarity_threshold_label:
 
 Log Scale Similarity Threshold
-------------
+------------------------------
 
 log_scale_similarity_threshold: float, default = 0.1
     :ref:`use_log_scale_label` along with log_scale_similarity_threshold can be used to ignore small changes in numbers by comparing their differences in logarithmic space. This is different than ignoring the difference based on significant digits. See the example above.
diff --git a/docs/optimizations.rst b/docs/optimizations.rst
@@ -61,9 +61,8 @@ cache_size : int >= 0, default=0
     Cache size to be used to improve the performance. A cache size of zero means it is disabled.
     Using the cache_size can dramatically improve the diff performance especially for the nested objects at the cost of more memory usage. However if cache hits rate is very low, having a cache actually reduces the performance.
 
-**************
 Cache Examples
-**************
+--------------
 
 For example lets take a look at the performance of the benchmark_deeply_nested_a in the `DeepDiff-Benchmark repo <https://github.com/seperman/deepdiff-benchmark/blob/master/benchmark.py>`_ .
 
diff --git a/docs/search_doc.rst b/docs/search_doc.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 grep is a more user friendly interface for DeepSearch. It takes exactly the same arguments as DeepSearch except that you pipe the object into it instead of passing it as a parameter.
 
 It works just like grep in linux shell!
diff --git a/docs/view.rst b/docs/view.rst
@@ -311,6 +311,9 @@ The pretty method has an optional parameter ``prefix`` that allows a prefix stri
 
 The ``prefix`` may also be a callable function. This function must accept ``**kwargs``; as of this version, the only parameter is ``diff`` but the signature allows for future expansion.
 The ``diff`` given will be the ``DeepDiff`` that ``pretty`` was called on; this allows interesting capabilities such as:
+
+.. code:: python
+
     >>> from deepdiff import DeepDiff
     >>> t1={1,2,4}
     >>> t2={2,3}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`DeepHash`
`2`	`4`
`3`	`5`	`DeepHash calculates the hash of objects based on their contents in a deterministic way.`