all: minor comment and typos cleanups

drew-512 · Drew O'Meara · web-flow · commit 6f8e06a46607 · 2022-10-05T09:25:39.000+02:00
Co-authored-by: Drew O'Meara &lt;drew@plan-systems.org&gt;
diff --git a/py/bigint.go b/py/bigint.go
@@ -55,7 +55,7 @@ func BigIntCheckExact(obj Object) (*BigInt, error) {
 	return bigInt, nil
 }
 
-// Checks that obj is exactly a bigInd and returns an error if not
+// Checks that obj is exactly a BigInt and returns an error if not
 func BigIntCheck(obj Object) (*BigInt, error) {
 	// FIXME should be checking subclasses
 	return BigIntCheckExact(obj)
@@ -65,7 +65,7 @@ func BigIntCheck(obj Object) (*BigInt, error) {
 
 // Convert an Object to an BigInt
 //
-// Retrurns ok as to whether the conversion worked or not
+// Returns ok as to whether the conversion worked or not
 func ConvertToBigInt(other Object) (*BigInt, bool) {
 	switch b := other.(type) {
 	case Int:
diff --git a/py/bool.go b/py/bool.go
@@ -52,7 +52,7 @@ func (a Bool) M__repr__() (Object, error) {
 
 // Convert an Object to an Bool
 //
-// Retrurns ok as to whether the conversion worked or not
+// Returns ok as to whether the conversion worked or not
 func convertToBool(other Object) (Bool, bool) {
 	switch b := other.(type) {
 	case Bool:
diff --git a/py/bytes.go b/py/bytes.go
@@ -187,7 +187,7 @@ func (a Bytes) M__repr__() (Object, error) {
 
 // Convert an Object to an Bytes
 //
-// Retrurns ok as to whether the conversion worked or not
+// Returns ok as to whether the conversion worked or not
 func convertToBytes(other Object) (Bytes, bool) {
 	switch b := other.(type) {
 	case Bytes:
diff --git a/py/complex.go b/py/complex.go
@@ -42,7 +42,7 @@ func ComplexNew(metatype *Type, args Tuple, kwargs StringDict) (Object, error) {
 
 // Convert an Object to an Complex
 //
-// Retrurns ok as to whether the conversion worked or not
+// Returns ok as to whether the conversion worked or not
 func convertToComplex(other Object) (Complex, bool) {
 	switch b := other.(type) {
 	case Complex:
diff --git a/py/float.go b/py/float.go
@@ -118,7 +118,7 @@ var floatDivisionByZero = ExceptionNewf(ZeroDivisionError, "float division by ze
 
 // Convert an Object to an Float
 //
-// Retrurns ok as to whether the conversion worked or not
+// Returns ok as to whether the conversion worked or not
 func convertToFloat(other Object) (Float, bool) {
 	switch b := other.(type) {
 	case Float:
diff --git a/py/int.go b/py/int.go
@@ -216,7 +216,7 @@ func cantConvert(a Object, to string) (Object, error) {
 
 // Convert an Object to an Int
 //
-// Retrurns ok as to whether the conversion worked or not
+// Returns ok as to whether the conversion worked or not
 func convertToInt(other Object) (Int, bool) {
 	switch b := other.(type) {
 	case Int:
diff --git a/py/none.go b/py/none.go
@@ -33,7 +33,7 @@ func (a NoneType) M__repr__() (Object, error) {
 
 // Convert an Object to an NoneType
 //
-// Retrurns ok as to whether the conversion worked or not
+// Returns ok as to whether the conversion worked or not
 func convertToNoneType(other Object) (NoneType, bool) {
 	switch b := other.(type) {
 	case NoneType:
diff --git a/py/run.go b/py/run.go
@@ -135,8 +135,11 @@ func RunSrc(ctx Context, pySrc string, pySrcDesc string, inModule interface{}) (
 }
 
 // RunCode executes the given code object within the given module and returns 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).
 func RunCode(ctx Context, code *Code, codeDesc string, inModule interface{}) (*Module, error) {
 	var (
diff --git a/py/string.go b/py/string.go
@@ -300,7 +300,7 @@ func (a String) M__imul__(other Object) (Object, error) {
 
 // Convert an Object to an String
 //
-// Retrurns ok as to whether the conversion worked or not
+// Returns ok as to whether the conversion worked or not
 func convertToString(other Object) (String, bool) {
 	switch b := other.(type) {
 	case String:
diff --git a/stdlib/stdlib.go b/stdlib/stdlib.go
@@ -47,7 +47,7 @@ type context struct {
 
 // NewContext creates a new gpython interpreter instance context.
 //
-// See type Context interface for info.
+// See interface py.Context defined in py/run.go
 func NewContext(opts py.ContextOpts) py.Context {
 	ctx := &context{
 		opts:    opts,
@@ -109,6 +109,7 @@ func (ctx *context) ModuleInit(impl *py.ModuleImpl) (*py.Module, error) {
 	return module, nil
 }
 
+// See interface py.Context defined in py/run.go
 func (ctx *context) ResolveAndCompile(pathname string, opts py.CompileOpts) (py.CompileOut, error) {
 	err := ctx.pushBusy()
 	defer ctx.popBusy()
@@ -202,7 +203,7 @@ func (ctx *context) popBusy() {
 	ctx.running.Done()
 }
 
-// Close -- see type py.Context
+// See interface py.Context defined in py/run.go
 func (ctx *context) Close() error {
 	ctx.closeOnce.Do(func() {
 		ctx.closing = true
@@ -216,7 +217,7 @@ func (ctx *context) Close() error {
 	return nil
 }
 
-// Done -- see type py.Context
+// See interface py.Context defined in py/run.go
 func (ctx *context) Done() <-chan struct{} {
 	return ctx.done
 }
@@ -274,6 +275,7 @@ func resolveRunPath(runPath string, opts py.CompileOpts, pathObjs []py.Object, t
 	return err
 }
 
+// See interface py.Context defined in py/run.go
 func (ctx *context) RunCode(code *py.Code, globals, locals py.StringDict, closure py.Tuple) (py.Object, error) {
 	err := ctx.pushBusy()
 	defer ctx.popBusy()
@@ -284,10 +286,12 @@ func (ctx *context) RunCode(code *py.Code, globals, locals py.StringDict, closur
 	return vm.EvalCode(ctx, code, globals, locals, nil, nil, nil, nil, closure)
 }
 
+// See interface py.Context defined in py/run.go
 func (ctx *context) GetModule(moduleName string) (*py.Module, error) {
 	return ctx.store.GetModule(moduleName)
 }
 
+// See interface py.Context defined in py/run.go
 func (ctx *context) Store() *py.ModuleStore {
 	return ctx.store
 }

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ type context struct {`
`47`	`47`
`48`	`48`	`// NewContext creates a new gpython interpreter instance context.`
`49`	`49`	`//`
`50`		`-// See type Context interface for info.`
	`50`	`+// See interface py.Context defined in py/run.go`
`51`	`51`	`func NewContext(opts py.ContextOpts) py.Context {`
`52`	`52`	`ctx := &context{`
`53`	`53`	`opts: opts,`
`@@ -109,6 +109,7 @@ func (ctx context) ModuleInit(impl py.ModuleImpl) (*py.Module, error) {`
`109`	`109`	`return module, nil`
`110`	`110`	`}`
`111`	`111`
	`112`	`+// See interface py.Context defined in py/run.go`
`112`	`113`	`func (ctx *context) ResolveAndCompile(pathname string, opts py.CompileOpts) (py.CompileOut, error) {`
`113`	`114`	`err := ctx.pushBusy()`
`114`	`115`	`defer ctx.popBusy()`
`@@ -202,7 +203,7 @@ func (ctx *context) popBusy() {`
`202`	`203`	`ctx.running.Done()`
`203`	`204`	`}`
`204`	`205`
`205`		`-// Close -- see type py.Context`
	`206`	`+// See interface py.Context defined in py/run.go`
`206`	`207`	`func (ctx *context) Close() error {`
`207`	`208`	`ctx.closeOnce.Do(func() {`
`208`	`209`	`ctx.closing = true`
`@@ -216,7 +217,7 @@ func (ctx *context) Close() error {`
`216`	`217`	`return nil`
`217`	`218`	`}`
`218`	`219`
`219`		`-// Done -- see type py.Context`
	`220`	`+// See interface py.Context defined in py/run.go`
`220`	`221`	`func (ctx *context) Done() <-chan struct{} {`
`221`	`222`	`return ctx.done`
`222`	`223`	`}`
`@@ -274,6 +275,7 @@ func resolveRunPath(runPath string, opts py.CompileOpts, pathObjs []py.Object, t`
`274`	`275`	`return err`
`275`	`276`	`}`
`276`	`277`
	`278`	`+// See interface py.Context defined in py/run.go`
`277`	`279`	`func (ctx context) RunCode(code py.Code, globals, locals py.StringDict, closure py.Tuple) (py.Object, error) {`
`278`	`280`	`err := ctx.pushBusy()`
`279`	`281`	`defer ctx.popBusy()`
`@@ -284,10 +286,12 @@ func (ctx context) RunCode(code py.Code, globals, locals py.StringDict, closur`
`284`	`286`	`return vm.EvalCode(ctx, code, globals, locals, nil, nil, nil, nil, closure)`
`285`	`287`	`}`
`286`	`288`
	`289`	`+// See interface py.Context defined in py/run.go`
`287`	`290`	`func (ctx context) GetModule(moduleName string) (py.Module, error) {`
`288`	`291`	`return ctx.store.GetModule(moduleName)`
`289`	`292`	`}`
`290`	`293`
	`294`	`+// See interface py.Context defined in py/run.go`
`291`	`295`	`func (ctx context) Store() py.ModuleStore {`
`292`	`296`	`return ctx.store`
`293`	`297`	`}`