Update CHANGELOG

python-poetry · May 31, 2024 · 69ea606 · 69ea606
1 parent d74372b
commit 69ea606
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 ### Fixed
 
+- Fix mypy errors when using tomlkit to modify toml document. ([#326](https://github.com/python-poetry/tomlkit/issues/326))
 - Fix the incompatiblity with 3.13 because of the `datetime.replace()` change. ([#333](https://github.com/python-poetry/tomlkit/issues/333))
 - Revert the change of parsing out-of-order tables. ([#347](https://github.com/python-poetry/tomlkit/issues/347))
 

diff --git a/tomlkit/items.py b/tomlkit/items.py
@@ -522,7 +522,9 @@ def __reduce_ex__(self, protocol):
         return self.__class__, self._getstate(protocol)
 
     # Leave it here to improve type hint for `tomlkit.parse`
-    # For example: `tomlkit.parse('pyproject.toml')['tool']['poetry']`
+    # For example:
+    #   doc = tomlkit.parse(Path('pyproject.toml').read_text())
+    #   print(doc['tool']['poetry'])
     def __getitem__(self, key) -> Any:
         raise NotImplementedError()