fixups, add docs

BadSingleton · BadSingleton · commit e469a8a73cfc · 2021-06-02T10:56:48.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -73,7 +73,6 @@ One must now either use enum members (e.g. `MyEnum.Option`), or use enum constru
 -   Providing an invalid type parameter to a generic type or method produces a helpful Python error
 -   Empty parameter names (as can be generated from F#) do not cause crashes
 
-
 ### Removed
 
 -   implicit assembly loading (you have to explicitly `clr.AddReference` before doing import)
diff --git a/src/runtime/importhook.cs b/src/runtime/importhook.cs
@@ -34,7 +34,6 @@ import clr
 class DotNetFinder(importlib.abc.MetaPathFinder):
     
     def __init__(self):
-        print('DotNetFinder init')
         super(DotNetFinder, self).__init__()
     
     @classmethod
@@ -115,6 +114,12 @@ internal static void RestoreRuntimeData(RuntimeDataStorage storage)
             SetupNamespaceTracking();
         }
 
+        /// <summary>
+        /// Sets up the tracking of loaded namespaces. This makes available to 
+        /// Python, as a Python object, the loaded namespaces. The set of loaded
+        /// namespaces is used during the import to verify if we can import a 
+        /// CLR assembly as a module or not. The set is stored on the clr module.
+        /// </summary>
         static void SetupNamespaceTracking ()
         {
             var newset = Runtime.PySet_New(IntPtr.Zero);
@@ -150,6 +155,10 @@ static void SetupNamespaceTracking ()
             PythonEngine.AddShutdownHandler(()=>AssemblyManager.namespaceAdded -= OnNamespaceAdded);
         }
 
+        /// <summary>
+        /// Removes the set of available namespaces from the clr module and 
+        /// removes the callback on the OnNamespaceAdded event.
+        /// </summary>
         static void TeardownNameSpaceTracking()
         {
             AssemblyManager.namespaceAdded -= OnNamespaceAdded;
diff --git a/src/runtime/moduleobject.cs b/src/runtime/moduleobject.cs
@@ -582,6 +582,15 @@ public static int _AtExit()
             return Runtime.AtExit();
         }
 
+
+        /// <summary>
+        /// Note: This should *not* be called directly.
+        /// The function that get/import a CLR assembly as a python module.
+        /// This function should only be called by the import machinery as seen
+        /// in importhook.cs
+        /// </summary>
+        /// <param name="spec">A ModuleSpec Python object</param>
+        /// <returns>A new reference to the imported module, as a PyObject.</returns>
         [ModuleFunction]
         [ForbidPythonThreads]
         public static PyObject _LoadClrModule(PyObject spec)
diff --git a/tests/domain_tests/TestRunner.cs b/tests/domain_tests/TestRunner.cs
@@ -1096,28 +1096,11 @@ assert sys.my_obj is not None
             },
             new TestCase
             {
-                // The C# code for this test doesn't matter.
+                // The C# code for this test doesn't matter; we're testing
+                // that the import hook behaves properly after a domain reload
                 Name = "import_after_reload",
-                DotNetBefore = @"
-                    namespace TestNamespace
-                    {
-                        [System.Serializable]
-                        public class Cls
-                        {
-                        }
-                    }",
-                DotNetAfter = @"
-                    namespace TestNamespace
-                    {
-                        [System.Serializable]
-                        public class WithNestedType
-                        {
-                            [System.Serializable]
-                            public class Cls
-                            {
-                            }
-                        }
-                    }",
+                DotNetBefore = "",
+                DotNetAfter = "",
                 PythonCode = @"
 import sys
 
