Skip to content

Commit

Permalink
Merge pull request #24 from jan-golda/patch-1
Browse files Browse the repository at this point in the history
Fix documentation for custom strategies
  • Loading branch information
toumorokoshi authored Mar 31, 2023
2 parents c96610a + 5c10415 commit 33a078a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Custom Strategies
Strategies are functions that satisfy the following properties:

* have the function signature (config, path, base, nxt)
* return the merged object, or None.
* return the merged object, or `deepmerge.STRATEGY_END`.

Example:

Expand All @@ -92,7 +92,7 @@ Example:
base.append(nxt[-1])
return base
If a strategy fails, an exception should not be raised. This is to
If a strategy fails, an exception should not be raised, instead it should return `deepmerge.STRATEGY_END`. This is to
ensure it can be chained with other strategies, or the fall-back.

Uniqueness of elements when merging
Expand All @@ -104,4 +104,4 @@ types, this includes structures that are not hashable such as
dictionaries.

In those cases, built-in deepmerge strategies will call repr()
on the object and hash that value instead.
on the object and hash that value instead.

0 comments on commit 33a078a

Please sign in to comment.