Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seperman committed Jul 6, 2023
1 parent d52b2da commit e05450e
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 11 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# DeepDiff Change log

- v6-3-1
- Bugfix deephash for paths by [maggelus](https://github.com/maggelus)
- Bugfix deephash compiled regex [maggelus](https://github.com/maggelus)
- Fix tests dependent on toml by [martin-kokos](https://github.com/martin-kokos)
- Bugfix for `include_paths` for nested dictionaries by [kor4ik](https://github.com/kor4ik)
- Use tomli and tomli-w for dealing with tomli files by [martin-kokos](https://github.com/martin-kokos)
- Bugfix for `datetime.date` by [Alex Sauer-Budge](https://github.com/amsb)
- v6-3-0
- `PrefixOrSuffixOperator`: This operator will skip strings that are suffix or prefix of each other.
- `include_obj_callback` and `include_obj_callback_strict` are added by [Håvard Thom](https://github.com/havardthom).
Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@ Tested on Python 3.7+ and PyPy3.

Please check the [ChangeLog](CHANGELOG.md) file for the detailed information.

DeepDiff 6-3-1

This release includes many bug fixes.

- Bugfix deephash for paths by [maggelus](https://github.com/maggelus)
- Bugfix deephash compiled regex [maggelus](https://github.com/maggelus)
- Fix tests dependent on toml by [martin-kokos](https://github.com/martin-kokos)
- Bugfix for `include_paths` for nested dictionaries by [kor4ik](https://github.com/kor4ik)
- Use tomli and tomli-w for dealing with tomli files by [martin-kokos](https://github.com/martin-kokos)
- Bugfix for `datetime.date` by [Alex Sauer-Budge](https://github.com/amsb)


DeepDiff 6-3-0

- [`PrefixOrSuffixOperator`](https://zepworks.com/deepdiff/current/custom.html#prefix-or-suffix-operator-label): This operator will skip strings that are suffix or prefix of each other.
Expand All @@ -31,11 +43,6 @@ DeepDiff 6-3-0
- `orjson` becomes optional again.
- Fix for `ignore_type_in_groups` with numeric values so it does not report number changes when the number types are different.

DeepDiff 6-2-0

- Major improvement in the diff report for lists when items are all hashable and the order of items is important.


## Installation

### Install from PyPi:
Expand Down
15 changes: 15 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ Changelog

DeepDiff Changelog

- v6-3-1

- Bugfix deephash for paths by
`maggelus <https://github.com/maggelus>`__
- Bugfix deephash compiled regex
`maggelus <https://github.com/maggelus>`__
- Fix tests dependent on toml by
`martin-kokos <https://github.com/martin-kokos>`__
- Bugfix for ``include_paths`` for nested dictionaries by
`kor4ik <https://github.com/kor4ik>`__
- Use tomli and tomli-w for dealing with tomli files by
`martin-kokos <https://github.com/martin-kokos>`__
- Bugfix for ``datetime.date`` by `Alex
Sauer-Budge <https://github.com/amsb>`__

- v6-3-0

- ``PrefixOrSuffixOperator``: This operator will skip strings that
Expand Down
25 changes: 19 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,25 @@ What is New
***********


DeepDiff 6-3-1
--------------

This release includes many bug fixes.

- Bugfix deephash for paths by
`maggelus <https://github.com/maggelus>`__
- Bugfix deephash compiled regex
`maggelus <https://github.com/maggelus>`__
- Fix tests dependent on toml by
`martin-kokos <https://github.com/martin-kokos>`__
- Bugfix for ``include_paths`` for nested dictionaries by
`kor4ik <https://github.com/kor4ik>`__
- Use tomli and tomli-w for dealing with tomli files by
`martin-kokos <https://github.com/martin-kokos>`__
- Bugfix for ``datetime.date`` by `Alex
Sauer-Budge <https://github.com/amsb>`__


DeepDiff 6-3-0
--------------

Expand All @@ -45,12 +64,6 @@ DeepDiff 6-3-0
- ``orjson`` becomes optional again.
- Fix for ``ignore_type_in_groups`` with numeric values so it does not report number changes when the number types are different.

DeepDiff 6-2-0
--------------

- Major improvement in the diff report for lists when items are all hashable and the order of items is important.


*********
Tutorials
*********
Expand Down

0 comments on commit e05450e

Please sign in to comment.