Document duplicate key

nineteendo · Aug 19, 2024 · 8df9561 · 8df9561
1 parent 19bd736
commit 8df9561
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/src/jsonyx/__init__.py b/src/jsonyx/__init__.py
@@ -1,4 +1,5 @@
 # Copyright (C) 2024 Nice Zombies
+# TODO(Nice Zombies): add changelog
 """jsonyx module for JSON manipulation."""
 from __future__ import annotations
 

diff --git a/src/jsonyx/_decoder.py b/src/jsonyx/_decoder.py
@@ -101,7 +101,7 @@ class DuplicateKey(str):
         """Duplicate key.
 
         >>> import jsonyx as json
-        >>> {"key": "value 1", json.DuplicateKey("key"): "value 2"}
+        >>> {'key': 'value 1', json.DuplicateKey('key'): 'value 2'}
         {'key': 'value 1', 'key': 'value 2'}
         """
 

diff --git a/src/jsonyx/_speedups.c b/src/jsonyx/_speedups.c
@@ -52,7 +52,13 @@ static Py_hash_t duplicatekey_hash(PyUnicodeObject *self) {
 static PyTypeObject PyDuplicateKeyType = {
     PyVarObject_HEAD_INIT(NULL, 0)
     .tp_name = "jsonyx.DuplicateKey",
-    .tp_doc = PyDoc_STR("Duplicate key"),
+    .tp_doc = PyDoc_STR(
+        "Duplicate key.\n"
+        "\n"
+        ">>> import jsonyx as json\n"
+        ">>> {'key': 'value 1', json.DuplicateKey('key'): 'value 2'}\n"
+        "{'key': 'value 1', 'key': 'value 2'}\n"
+    ),
     .tp_hash = (hashfunc)duplicatekey_hash,
 };