Apply suggestions from code review

Co-authored-by: per1234 <[email protected]>
arduino · cmaglie · May 24, 2022 · Apr 27, 2022 · Mar 31, 2022 · Mar 14, 2022
commit 6156a26399aed1932388b42ee730d099ac521763
diff --git a/arduino/errors.go b/arduino/errors.go
@@ -212,21 +212,21 @@ func (e *UnknownProfileError) ToRPCStatus() *status.Status {
 	return status.New(codes.NotFound, e.Error())
 }
 
-// InvlaidProfileError is returned when the profile has errors
-type InvlaidProfileError struct {
+// InvalidProfileError is returned when the profile has errors
+type InvalidProfileError struct {
 	Cause error
 }
 
-func (e *InvlaidProfileError) Error() string {
+func (e *InvalidProfileError) Error() string {
 	return composeErrorMsg(tr("Invalid profile"), e.Cause)
 }
 
-func (e *InvlaidProfileError) Unwrap() error {
+func (e *InvalidProfileError) Unwrap() error {
 	return e.Cause
 }
 
 // ToRPCStatus converts the error into a *status.Status
-func (e *InvlaidProfileError) ToRPCStatus() *status.Status {
+func (e *InvalidProfileError) ToRPCStatus() *status.Status {
 	return status.New(codes.FailedPrecondition, e.Error())
 }
 

diff --git a/arduino/sketch/profiles.go b/arduino/sketch/profiles.go
@@ -29,7 +29,7 @@ import (
 	"gopkg.in/yaml.v2"
 )
 
-// Project represents all the
+// Project represents all the profiles defined for the sketch
 type Project struct {
 	Profiles       map[string]*Profile `yaml:"profiles"`
 	DefaultProfile string              `yaml:"default_profile"`
@@ -141,9 +141,9 @@ func (p *ProfilePlatformReference) UnmarshalYAML(unmarshal func(interface{}) err
 		return err
 	}
 	if platformID, ok := data["platform"]; !ok {
-		return fmt.Errorf(tr("missing 'platform' directive"))
+		return fmt.Errorf(tr("missing '%s' directive", "platform"))
 	} else if platformID, platformVersion, ok := parseNameAndVersion(platformID); !ok {
-		return fmt.Errorf(tr("invalid 'platform' directive"))
+		return fmt.Errorf(tr("invalid '%s' directive", "platform"))
 	} else if c, err := semver.Parse(platformVersion); err != nil {
 		return fmt.Errorf("%s: %w", tr("error parsing version constraints"), err)
 	} else if split := strings.SplitN(platformID, ":", 2); len(split) != 2 {
@@ -157,7 +157,7 @@ func (p *ProfilePlatformReference) UnmarshalYAML(unmarshal func(interface{}) err
 	if rawIndexURL, ok := data["platform_index_url"]; ok {
 		indexURL, err := url.Parse(rawIndexURL)
 		if err != nil {
-			return fmt.Errorf("%s: %w", tr("invlid platform index URL:"), err)
+			return fmt.Errorf("%s: %w", tr("invalid platform index URL:"), err)
 		}
 		p.PlatformIndexURL = indexURL
 	}

diff --git a/cli/arguments/profiles.go b/cli/arguments/profiles.go
@@ -30,12 +30,12 @@ func (f *Profile) AddToCommand(cmd *cobra.Command) {
 	// TODO: register autocompletion
 }
 
-// Get returns the profile
+// Get returns the profile name
 func (f *Profile) Get() string {
 	return f.profile
 }
 
-// String returns the profile
+// String returns the profile name
 func (f *Profile) String() string {
 	return f.profile
 }

diff --git a/cli/instance/instance.go b/cli/instance/instance.go
@@ -41,7 +41,7 @@ func CreateAndInit() *rpc.Instance {
 	return inst
 }
 
-// CreateAndInitWithProfile return a new initialized instance using the given profile in the give sketch.
+// CreateAndInitWithProfile returns a new initialized instance using the given profile of the given sketch.
 // If Create fails the CLI prints an error and exits since to execute further operations a valid Instance is mandatory.
 // If Init returns errors they're printed only.
 func CreateAndInitWithProfile(profileName string, sketchPath *paths.Path) (*rpc.Instance, *rpc.Profile) {

diff --git a/rpc/cc/arduino/cli/commands/v1/commands.proto b/rpc/cc/arduino/cli/commands/v1/commands.proto
@@ -200,7 +200,7 @@ message InitRequest {
   Instance instance = 1;
   // Profile to use
   string profile = 2;
-  // The path where the sketch is stored (contains also the profile.yml path)
+  // The path where the sketch is stored
   string sketch_path = 3;
 }
 
@@ -214,7 +214,7 @@ message InitResponse {
   oneof message {
     Progress init_progress = 1;
     google.rpc.Status error = 2;
-    // Fqbn selected in profile (optional)
+    // FQBN selected in profile (optional)
     Profile profile = 3;
   }
 }