Document nPython/Console usage

vmuriart · vmuriart · commit a1b913676dc7 · 2017-02-06T11:05:23.000-07:00
Closes #358
diff --git a/src/console/pythonconsole.cs b/src/console/pythonconsole.cs
@@ -5,6 +5,14 @@
 
 namespace Python.Runtime
 {
+    /// <summary>
+    /// Example of Embedding Python inside of a .NET program.
+    /// </summary>
+    /// <remarks>
+    /// It has similar functionality to doing `import clr` from within Python, but this does it
+    /// the other way around; That is, it loads Python inside of .NET program.
+    /// See https://github.com/pythonnet/pythonnet/issues/358 for more info.
+    /// </remarks>
     public sealed class PythonConsole
     {
         private static AssemblyLoader assemblyLoader = new AssemblyLoader();
@@ -41,7 +49,7 @@ public AssemblyLoader()
                 AppDomain.CurrentDomain.AssemblyResolve += (sender, args) =>
                 {
                     string shortName = args.Name.Split(',')[0];
-                    string resourceName = string.Format("{0}.dll", shortName);
+                    string resourceName = $"{shortName}.dll";
 
                     if (loadedAssemblies.ContainsKey(resourceName))
                     {
@@ -60,7 +68,6 @@ public AssemblyLoader()
                             return assembly;
                         }
                     }
-
                     return null;
                 };
             }

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,14 @@`
`5`	`5`
`6`	`6`	`namespace Python.Runtime`
`7`	`7`	`{`
	`8`	`+ /// <summary>`
	`9`	`+ /// Example of Embedding Python inside of a .NET program.`
	`10`	`+ /// </summary>`
	`11`	`+ /// <remarks>`
	`12`	+ /// It has similar functionality to doing `import clr` from within Python, but this does it
	`13`	`+ /// the other way around; That is, it loads Python inside of .NET program.`
	`14`	`+ /// See https://github.com/pythonnet/pythonnet/issues/358 for more info.`
	`15`	`+ /// </remarks>`
`8`	`16`	`public sealed class PythonConsole`
`9`	`17`	`{`
`10`	`18`	`private static AssemblyLoader assemblyLoader = new AssemblyLoader();`
`@@ -41,7 +49,7 @@ public AssemblyLoader()`
`41`	`49`	`AppDomain.CurrentDomain.AssemblyResolve += (sender, args) =>`
`42`	`50`	`{`
`43`	`51`	`string shortName = args.Name.Split(',')[0];`
`44`		`- string resourceName = string.Format("{0}.dll", shortName);`
	`52`	`+ string resourceName = $"{shortName}.dll";`
`45`	`53`
`46`	`54`	`if (loadedAssemblies.ContainsKey(resourceName))`
`47`	`55`	`{`
`@@ -60,7 +68,6 @@ public AssemblyLoader()`
`60`	`68`	`return assembly;`
`61`	`69`	`}`
`62`	`70`	`}`
`63`		`-`
`64`	`71`	`return null;`
`65`	`72`	`};`
`66`	`73`	`}`