Document private helpers added during free-threading prep

pythonnet · greateggsgreg · May 9, 2026 · May 9, 2026 · May 9, 2026 · May 9, 2026
commit 2c9f861ed2be795a57a861b356a63b44f1c1aae6
diff --git a/src/runtime/DelegateManager.cs b/src/runtime/DelegateManager.cs
@@ -47,6 +47,10 @@ private Type GetDispatcher(Type dtype)
             }
         }
 
+        /// <summary>
+        /// Emits a new <see cref="Dispatcher"/> subclass for <paramref name="dtype"/>
+        /// and caches it.  Must be called under <c>_emitLock</c>.
+        /// </summary>
         private Type BuildDispatcher(Type dtype)
         {
             string name = $"__{dtype.FullName}Dispatcher";

diff --git a/src/runtime/MethodBinder.cs b/src/runtime/MethodBinder.cs
@@ -213,6 +213,10 @@ internal MethodBase[] GetMethods()
             }
         }
 
+        /// <summary>
+        /// Sort key for <see cref="GetMethods"/>: derived-class methods come before
+        /// their base, otherwise by precomputed precedence (lower wins).
+        /// </summary>
         private static int CompareByDeclaringTypeThenPrecedence(
             KeyValuePair<MethodBase, int> a, KeyValuePair<MethodBase, int> b)
         {

diff --git a/src/runtime/Native/ABI.cs b/src/runtime/Native/ABI.cs
@@ -43,6 +43,9 @@ internal static void Initialize(Version version)
             TypeOffset.Use(typeOffsets, nativeOffsetsClass == null ? ObjectHeadOffset : 0);
         }
 
+        /// <summary>
+        /// True when the running interpreter is a Py_GIL_DISABLED (free-threaded) build.
+        /// </summary>
         static bool DetectFreeThreaded()
         {
             // sys._is_gil_enabled() was added in Python 3.13; absent means GIL build.
@@ -56,6 +59,10 @@ static bool DetectFreeThreaded()
             return Runtime.PyObject_IsTrue(result.Borrow()) == 0;
         }
 
+        /// <summary>
+        /// Locates the offset of <c>ob_refcnt</c> inside <c>PyObject</c> by allocating a
+        /// fresh list and scanning for its refcount value of 1.  GIL builds only.
+        /// </summary>
         static unsafe int ProbeRefCountOffset()
         {
             using var tempObject = Runtime.PyList_New(0);

diff --git a/src/runtime/PythonTypes/PyBuffer.cs b/src/runtime/PythonTypes/PyBuffer.cs
@@ -228,6 +228,10 @@ public void Read(byte[] buffer, int destinationOffset, int count, nint sourceOff
         // 0/1; atomic so finalizer + Dispose cannot double-free the buffer.
         private int disposedValue;
 
+        /// <summary>
+        /// Throws <see cref="ObjectDisposedException"/> if <see cref="Dispose()"/> has
+        /// already released the buffer view.
+        /// </summary>
         private void ThrowIfDisposed()
         {
             if (Volatile.Read(ref disposedValue) != 0)

diff --git a/src/runtime/Types/ClassDerived.cs b/src/runtime/Types/ClassDerived.cs
@@ -201,6 +201,10 @@ internal static Type CreateDerivedType(string name,
             }
         }
 
+        /// <summary>
+        /// Emits the CLR type for a Python subclass.  Must be called under
+        /// <c>_buildersLock</c> since Reflection.Emit is not thread-safe.
+        /// </summary>
         private static Type CreateDerivedTypeImpl(string name,
             Type baseType,
             IList<Type> typeInterfaces,