Skip to content

Commit

Permalink
Updated README file with changes from intro section
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Maier <[email protected]>
  • Loading branch information
andy-maier committed May 5, 2024
1 parent c024c74 commit f005b0c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,13 @@ The
[NocaseDict](https://nocasedict.readthedocs.io/en/stable/reference.html#nocasedict.NocaseDict)
class supports the functionality of the built-in
[dict class of Python 3.8](https://docs.python.org/3.8/library/stdtypes.html#dict)
on all Python versions it supports with the following exceptions (and the
case-insensitivity of course):

- The `iter..()`, `view..()` and `has_key()` methods are only present
on Python 2, consistent with the built-in `dict` class.
- The `keys()`, `values()` and `items()` methods return a list on
Python 2 and a dictionary view on Python 3, consistent with the
built-in `dict` class.
on all Python versions it supports.

Limitation: Any functionalities added to the `dict` class in Python 3.9 or
later are not yet supported. These are:

* `d | other` - Added in Python 3.9.
* `d |= other` - Added in Python 3.9.

The case-insensitivity is achieved by matching any key values as their
casefolded values. By default, the casefolding is performed with
Expand Down
3 changes: 3 additions & 0 deletions docs/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ Released: not yet
* Docs: Added Python 3.12 to the supported versions in the package metadata.
(issue #196)

* Docs: Updated the README file with the changes from the introduction section
w.r.t. Python 2 and limitations. (issue #195)

**Enhancements:**

**Cleanup:**
Expand Down

0 comments on commit f005b0c

Please sign in to comment.