Add method docs

Author: Nicholas Thomson

pkg/model/model.go

@@ -159,7 +159,7 @@ func (m *Model) GetCRDs() ([]*CRD, error) {
 			} else if fieldConfig.CustomField != nil {
 				customField := fieldConfig.CustomField
 				if customField.MemberShape != "" {
-					memberShapeRef, found = m.SDKAPI.GetCustomArrayRef(customField.MemberShape)
+					memberShapeRef, found = m.SDKAPI.GetCustomListRef(customField.MemberShape)
 				} else {
 					memberShapeRef, found = m.SDKAPI.GetCustomMapRef(customField.ValueShape)
 				}
@@ -251,7 +251,7 @@ func (m *Model) GetCRDs() ([]*CRD, error) {
 			} else if fieldConfig.CustomField != nil {
 				customField := fieldConfig.CustomField
 				if customField.MemberShape != "" {
-					memberShapeRef, found = m.SDKAPI.GetCustomArrayRef(customField.MemberShape)
+					memberShapeRef, found = m.SDKAPI.GetCustomListRef(customField.MemberShape)
 				} else {
 					memberShapeRef, found = m.SDKAPI.GetCustomMapRef(customField.ValueShape)
 				}

pkg/sdk/custom_shapes.go

@@ -25,8 +25,8 @@ var (
 )
 
 const (
-	ShapeNameTemplateArray = "%sList"
-	ShapeNameTemplateMap   = "%sMap"
+	ShapeNameTemplateList = "%sList"
+	ShapeNameTemplateMap  = "%sMap"
 )
 
 type CustomShape struct {
@@ -57,8 +57,8 @@ func (h *Helper) InjectCustomShapes(sdkapi *SDKAPI) error {
 		sdkapi.CustomShapes = append(sdkapi.CustomShapes, customShape)
 	}
 
-	for _, memberShape := range h.getCustomArrayFieldMembers() {
-		customShape, err := injector.newArray(memberShape)
+	for _, memberShape := range h.getCustomListFieldMembers() {
+		customShape, err := injector.newList(memberShape)
 		if err != nil {
 			return err
 		}
@@ -70,7 +70,9 @@ func (h *Helper) InjectCustomShapes(sdkapi *SDKAPI) error {
 	return nil
 }
 
-func (h *Helper) getCustomArrayFieldMembers() []string {
+// getCustomListFieldMembers finds all of the custom list fields that need to
+// be generated as defined in the generator config.
+func (h *Helper) getCustomListFieldMembers() []string {
 	members := []string{}
 
 	for _, resource := range h.cfg.Resources {
@@ -84,6 +86,8 @@ func (h *Helper) getCustomArrayFieldMembers() []string {
 	return members
 }
 
+// getCustomMapFieldMembers finds all of the custom map fields that need to be
+// generated as defined in the generator config.
 func (h *Helper) getCustomMapFieldMembers() []string {
 	members := []string{}
 
@@ -98,6 +102,8 @@ func (h *Helper) getCustomMapFieldMembers() []string {
 	return members
 }
 
+// createShapeRefForMember creates a minimal ShapeRef type to encapsulate a
+// shape.
 func (i *customShapeInjector) createShapeRefForMember(shape *awssdkmodel.Shape) *awssdkmodel.ShapeRef {
 	return &awssdkmodel.ShapeRef{
 		API:           i.sdkAPI.API,
@@ -107,6 +113,8 @@ func (i *customShapeInjector) createShapeRefForMember(shape *awssdkmodel.Shape)
 	}
 }
 
+// newList loads a shape given its name and creates a custom shape that is a
+// map with strings as keys and that shape as the value.
 func (i *customShapeInjector) newMap(valueShapeName string) (*CustomShape, error) {
 	valueShape, exists := i.sdkAPI.API.Shapes[valueShapeName]
 	if !exists {
@@ -136,14 +144,16 @@ func (i *customShapeInjector) newMap(valueShapeName string) (*CustomShape, error
 	return &CustomShape{shape, shapeRef, nil, &valueShapeName}, nil
 }
 
-func (i *customShapeInjector) newArray(memberShapeName string) (*CustomShape, error) {
+// newList loads a shape given its name and creates a custom shape that is a
+// list of that shape.
+func (i *customShapeInjector) newList(memberShapeName string) (*CustomShape, error) {
 	memberShape, exists := i.sdkAPI.API.Shapes[memberShapeName]
 	if !exists {
 		return nil, ErrMemberShapeNotFound
 	}
 	memberShapeRef := i.createShapeRefForMember(memberShape)
 
-	shapeName := fmt.Sprintf(ShapeNameTemplateArray, memberShape.ShapeName)
+	shapeName := fmt.Sprintf(ShapeNameTemplateList, memberShape.ShapeName)
 	documentation := ""
 
 	shape := &awssdkmodel.Shape{

pkg/sdk/helper.go

@@ -240,8 +240,8 @@ func (a *SDKAPI) GetOperationMap(cfg *ackgenconfig.Config) *operations.Operation
 	return &opMap
 }
 
-// GetCustomArrayRef finds a ShapeRef for a supplied custom slice field
-func (a *SDKAPI) GetCustomArrayRef(memberShapeName string) (*awssdkmodel.ShapeRef, bool) {
+// GetCustomListRef finds a ShapeRef for a supplied custom slice field
+func (a *SDKAPI) GetCustomListRef(memberShapeName string) (*awssdkmodel.ShapeRef, bool) {
 	for _, shape := range a.CustomShapes {
 		if shape.MemberShapeName != nil && *shape.MemberShapeName == memberShapeName {
 			return shape.ShapeRef, true