Apply suggestions from code review

Co-authored-by: per1234 <[email protected]>

Author: umbynos

Diff for: cli/common/common.go

@@ -80,7 +80,7 @@ func GetUploadToolDir(packageIndex *packageindex.Index, board *firmwareindex.Ind
 }
 
 // FlashSketch is the business logic that handles the flashing procedure,
-// it returns using a buffer the out and the err of the programmer
+// it returns using a buffer the stdout and the stderr of the programmer
 func FlashSketch(board *firmwareindex.IndexBoard, sketch string, uploadToolDir *paths.Path, address string) (programmerOut, programmerErr *bytes.Buffer, err error) {
 	bootloaderPort, err := GetNewAddress(board, address)
 	if err != nil {

Diff for: docs/usage.md

@@ -57,7 +57,7 @@ connection:
 Firmware version installed: 1.4.8
 ```
 
-You can also use the `--format json` to parse the output with more ease.
+You can also use the `--format json` flag to parse the output with more ease.
 
 ### Certificates
 

Diff for: flasher/flasher.go

@@ -86,7 +86,7 @@ type FlashResult struct {
 	Version    string      `json:"version,omitempty"`
 }
 
-// ExecOutput contais the stdout and stderr output, they are used to store the output of the flashing and upload
+// ExecOutput contains the stdout and stderr output, they are used to store the output of the flashing and upload
 type ExecOutput struct {
 	Stdout string `json:"stdout"`
 	Stderr string `json:"stderr"`

Diff for: indexes/firmwareindex/firmwareindex.go

@@ -67,7 +67,7 @@ type IndexFirmware struct {
 	Module   string                 `json:"module,required"`
 }
 
-// IndexSketch represents the sketch used to upload the new firmware on a board.
+// IndexSketch represents a sketch used to manage firmware on a board.
 type IndexSketch struct {
 	URL      string      `json:"url,required"`
 	Checksum string      `json:"checksum,required"`