Add tomlkit.dump() example (#370)

python-poetry · Jul 24, 2024 · 2344a42 · 2344a42
1 parent 60ed905
commit 2344a42
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/tomlkit/api.py b/tomlkit/api.py
@@ -75,6 +75,11 @@ def dump(data: Mapping, fp: IO[str], *, sort_keys: bool = False) -> None:
 
     :param data: a dict-like object to dump
     :param sort_keys: if true, sort the keys in alphabetic order
+
+    :Example:
+
+    >>> with open("output.toml", "w") as fp:
+    ...     tomlkit.dump(data, fp)
     """
     fp.write(dumps(data, sort_keys=sort_keys))