additional comments

Signed-off-by: Angelo De Caro <[email protected]>

Author: adecaro

platform/view/services/view/child.go

@@ -20,6 +20,9 @@ type ParentContext interface {
 	PutSession(caller view.View, party view.Identity, session view.Session) error
 }
 
+// ChildContext is a view context with a parent.
+// It allows the developer to override session and initiator.
+// It also supports error callbacks.
 type ChildContext struct {
 	Parent ParentContext
 
@@ -28,18 +31,22 @@ type ChildContext struct {
 	errorCallbackFuncs []func()
 }
 
+// NewChildContextFromParent return a new ChildContext from the given parent
 func NewChildContextFromParent(parentContext ParentContext) *ChildContext {
 	return NewChildContext(parentContext, nil, nil, nil)
 }
 
+// NewChildContextFromParentAndSession return a new ChildContext from the given parent and session
 func NewChildContextFromParentAndSession(parentContext ParentContext, session view.Session) *ChildContext {
 	return NewChildContext(parentContext, session, nil, nil)
 }
 
+// NewChildContextFromParentAndInitiator return a new ChildContext from the given parent and initiator view
 func NewChildContextFromParentAndInitiator(parentContext ParentContext, initiator view.View) *ChildContext {
 	return NewChildContext(parentContext, nil, initiator, nil)
 }
 
+// NewChildContext return a new ChildContext from the given arguments
 func NewChildContext(parentContext ParentContext, session view.Session, initiator view.View, errorCallbackFuncs ...func()) *ChildContext {
 	return &ChildContext{Parent: parentContext, session: session, initiator: initiator, errorCallbackFuncs: errorCallbackFuncs}
 }

platform/view/services/view/context.go

@@ -63,6 +63,7 @@ type Context struct {
 	localIdentityChecker LocalIdentityChecker
 }
 
+// NewContextForInitiator returns a new Context for an initiator view
 func NewContextForInitiator(
 	contextID string,
 	context context.Context,
@@ -102,6 +103,7 @@ func NewContextForInitiator(
 	return ctx, nil
 }
 
+// NewContext returns a new Context
 func NewContext(
 	context context.Context,
 	sp services.Provider,

platform/view/services/view/view.go

@@ -16,6 +16,8 @@ import (
 	"go.opentelemetry.io/otel/trace"
 )
 
+// ViewContext is an alias for view.Context
+//
 //go:generate counterfeiter -o mock/context.go -fake-name Context . ViewContext
 type ViewContext = view.Context
 

platform/view/view/context.go

@@ -59,15 +59,16 @@ func WithViewCall(f func(Context) (interface{}, error)) RunViewOption {
 	}
 }
 
-// WithSameContext is used to reuse the context
+// WithSameContext is used to reuse the view context
 func WithSameContext() RunViewOption {
 	return func(o *RunViewOptions) error {
 		o.SameContext = true
 		return nil
 	}
 }
 
-// WithContext is used to pass a different context to the view
+// WithContext is used to pass a different context.Context to the view.
+// It includes the effect of WithSameContext as well.
 func WithContext(ctx context.Context) RunViewOption {
 	return func(o *RunViewOptions) error {
 		o.SameContext = true