comment and cruft cleanup

Drew O'Meara · Drew O'Meara · commit 6242836f2110 · 2022-01-10T11:03:11.000-06:00
diff --git a/examples/multi-ctx/main.go b/examples/multi-ctx/main.go
@@ -20,7 +20,7 @@ func main() {
 
 	// The total job count implies a fixed amount of work.
 	// The number of workers is how many py.Ctx (in concurrent goroutines) to pull jobs off the queue.
-	// One worker does all the work serially while N number of workers will (ideally) divide that up.
+	// One worker does all the work serially while N number of workers will (ideally) divides up.
 	totalJobs := 20
 
 	for i := 0; i < 10; i++ {
diff --git a/py/run.go b/py/run.go
@@ -12,13 +12,6 @@ const (
 	SingleMode CompileMode = "single" // Compile a single (interactive) statement
 )
 
-type RunFlags int32
-
-const (
-	// RunOpts.FilePath is intelligently interpreted to load the appropriate pyc object (otherwise new code is generated from the implied .py file)
-	SmartCodeAcquire RunFlags = 0x01
-)
-
 // Ctx is gpython virtual environment instance ("context"), providing a mechanism
 // for multiple gpython interpreters to run concurrently without restriction.
 //
@@ -51,45 +44,37 @@ type Ctx interface {
 	Store() *Store
 }
 
-const (
-	SrcFileExt  = ".py"
-	CodeFileExt = ".pyc"
-)
-
-type StdLib int32
-
-const (
-	Lib_sys StdLib = 1 << iota
-	Lib_time
-
-	CoreLibs = Lib_sys | Lib_time
-)
-
+// CompileOpts specifies options for high-level compilation.
 type CompileOpts struct {
 	UseSysPaths bool   // If set, sys.path will be used to resolve relative pathnames
-	CurDir      string // If non-nil, this is the path of the current working directory.  If nil, os.Getwd() is used.
+	CurDir      string // If non-empty, this is the path of the current working directory.  If empty, os.Getwd() is used.
 }
 
+// CompileOut is the output object of high-level compilation, e.g. ResolveAndCompile()
 type CompileOut struct {
 	SrcPathname string // Resolved pathname the .py file that was compiled (if applicable)
 	PycPathname string // Pathname of the .pyc file read and/or written (if applicable)
 	FileDesc    string // Pathname to be used for a a module's "__file__" attrib
 	Code        *Code  // Read/Output code object ready for execution
 }
 
-// Can be changed during runtime and will \play nice with others using DefaultCtxOpts()
-var CoreSysPaths = []string{
+// DefaultCoreSysPaths specify default search paths for module sys
+// This can be changed during runtime and plays nice with others using DefaultCtxOpts()
+var DefaultCoreSysPaths = []string{
 	".",
 	"lib",
 }
 
-// Can be changed during runtime and will \play nice with others using DefaultCtxOpts()
-var AuxSysPaths = []string{
+// DefaultAuxSysPaths are secondary default search paths for module sys.
+// This can be changed during runtime and plays nice with others using DefaultCtxOpts()
+// They are separated from the default core paths since they the more likley thing you will want to completely replace when using gpython.
+var DefaultAuxSysPaths = []string{
 	"/usr/lib/python3.4",
 	"/usr/local/lib/python3.4/dist-packages",
 	"/usr/lib/python3/dist-packages",
 }
 
+// CtxOpts specifies fundamental environment and input settings for creating a new py.Ctx
 type CtxOpts struct {
 	SysArgs  []string // sys.argv initializer
 	SysPaths []string // sys.path initializer
@@ -100,9 +85,9 @@ var (
 	// Calling this ensure that you future proof you code for suggested/default settings.
 	DefaultCtxOpts = func() CtxOpts {
 		opts := CtxOpts{
-			SysPaths: CoreSysPaths,
+			SysPaths: DefaultCoreSysPaths,
 		}
-		opts.SysPaths = append(opts.SysPaths, AuxSysPaths...)
+		opts.SysPaths = append(opts.SysPaths, DefaultAuxSysPaths...)
 		return opts
 	}
 
@@ -115,7 +100,7 @@ var (
 	Compile func(src, srcDesc string, mode CompileMode, flags int, dont_inherit bool) (*Code, error)
 )
 
-// Resolves the given pathname, compiles as needed, and runs that code in the given module, returning the Module to indicate success.
+// RunFile resolves the given pathname, compiles as needed, and runs that code in the given module, returning the Module to indicate success.
 // If inModule is a *Module, then the code is run in that module.
 // If inModule is nil, the code is run in a new __main__ module (and the new Module is returned).
 // If inModule is a string, the code is run in a new module with the given name (and the new Module is returned).
