Add Doc/c-api/hashing.rst for hash-related C macros

vstinner · Mar 9, 2024 · Oct 28, 2023 · Oct 29, 2023 · Oct 30, 2023 · Oct 30, 2023
commit de4e3aef3b4fcae549e847441ffa27a1e23819d0
diff --git a/Doc/c-api/hashing.rst b/Doc/c-api/hashing.rst
@@ -0,0 +1,20 @@
+Parameters of the numeric hash implementation
+=============================================
+
+See :ref:`numeric-hash` for more details about hashing of numeric types.
+
+.. c:macro:: _PyHASH_MODULUS
+
+   The Mersenne prime ``P = 2**n -1``, used for numeric hash scheme.
+
+.. c:macro:: _PyHASH_BITS
+
+   The exponent ``n`` of ``P``.
+
+.. c:macro:: _PyHASH_INF
+
+   The hash value returned for a positive infinity.
+
+.. c:macro:: _PyHASH_IMAG
+
+   The multiplier used for the imaginary part of a complex number.
diff --git a/Doc/c-api/utilities.rst b/Doc/c-api/utilities.rst
@@ -20,3 +20,4 @@ and parsing function arguments and constructing Python values from C values.
    reflection.rst
    codec.rst
    perfmaps.rst
+   hashing.rst