Link to identifiers

nineteendo · Feb 11, 2025 · 3125156 · 3125156
1 parent 825d8d4
commit 3125156
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/docs/source/cli/jsonyx-diff.rst b/docs/source/cli/jsonyx-diff.rst
@@ -68,7 +68,7 @@ Options
 
 .. option:: -q, --unquoted-keys
 
-    Don't quote keys which are identifiers.
+    Don't quote keys which are :ref:`identifiers <identifiers>`.
 
 .. option:: -s, --sort-keys
 

diff --git a/docs/source/cli/jsonyx-format.rst b/docs/source/cli/jsonyx-format.rst
@@ -63,7 +63,7 @@ Options
 
 .. option:: -q, --unquoted-keys
 
-    Don't quote keys which are identifiers.
+    Don't quote keys which are :ref:`identifiers <identifiers>`..
 
 .. option:: -s, --sort-keys
 

diff --git a/docs/source/cli/jsonyx-patch.rst b/docs/source/cli/jsonyx-patch.rst
@@ -68,7 +68,7 @@ Options
 
 .. option:: -q, --unquoted-keys
 
-    Don't quote keys which are identifiers.
+    Don't quote keys which are :ref:`identifiers <identifiers>`..
 
 .. option:: -s, --sort-keys
 

diff --git a/src/jsonyx/__init__.py b/src/jsonyx/__init__.py
@@ -244,7 +244,7 @@ def write(
     :param indent: the number of spaces or string to indent with
     :param indent_leaves: indent leaf objects and arrays
     :param max_indent_level: the level up to which to indent
-    :param quoted_keys: quote keys which are identifiers
+    :param quoted_keys: quote keys which are :ref:`identifiers <identifiers>`
     :param separators: the item and key separator
     :param sort_keys: sort the keys of objects
     :param trailing_comma: add a trailing comma when indented
@@ -321,7 +321,7 @@ def dump(
     :param indent: the number of spaces or string to indent with
     :param indent_leaves: indent leaf objects and arrays
     :param max_indent_level: the level up to which to indent
-    :param quoted_keys: quote keys which are identifiers
+    :param quoted_keys: quote keys which are :ref:`identifiers <identifiers>`
     :param separators: the item and key separator
     :param sort_keys: sort the keys of objects
     :param trailing_comma: add a trailing comma when indented
@@ -394,7 +394,7 @@ def dumps(
     :param indent: the number of spaces or string to indent with
     :param indent_leaves: indent leaf objects and arrays
     :param max_indent_level: the level up to which to indent
-    :param quoted_keys: quote keys which are identifiers
+    :param quoted_keys: quote keys which are :ref:`identifiers <identifiers>`
     :param separators: the item and key separator
     :param sort_keys: sort the keys of objects
     :param trailing_comma: add a trailing comma when indented

diff --git a/src/jsonyx/_encoder.py b/src/jsonyx/_encoder.py
@@ -306,7 +306,7 @@ class Encoder:
     :param indent: the number of spaces or string to indent with
     :param indent_leaves: indent leaf objects and arrays
     :param max_indent_level: the level up to which to indent
-    :param quoted_keys: quote keys which are identifiers
+    :param quoted_keys: quote keys which are :ref:`identifiers <identifiers>`
     :param separators: the item and key separator
     :param sort_keys: sort the keys of objects
     :param trailing_comma: add a trailing comma when indented

diff --git a/src/jsonyx/allow.py b/src/jsonyx/allow.py
@@ -71,7 +71,7 @@
 """
 
 UNQUOTED_KEYS: frozenset[str] = frozenset({"unquoted_keys"})
-"""Allow unquoted keys in objects which are identifiers.
+"""Allow unquoted keys in objects which are :ref:`identifiers <identifiers>`.
 
 .. versionadded:: 2.0