Skip to content

Commit 35fb9d3

Browse files
eduherminiocmaglie
authored andcommitted
Minor style changes in code documentation
1 parent f8e52e2 commit 35fb9d3

File tree

31 files changed

+65
-65
lines changed

31 files changed

+65
-65
lines changed

arduino/cores/tools.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import (
3030
// Tool represents a single Tool, part of a Package.
3131
type Tool struct {
3232
Name string `json:"name,required"` // The Name of the Tool.
33-
Releases map[string]*ToolRelease `json:"releases"` //Maps Version to Release.
33+
Releases map[string]*ToolRelease `json:"releases"` // Maps Version to Release.
3434
Package *Package `json:"-"`
3535
}
3636

builder_client_helpers/alive.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func (c *Client) PingAlive(ctx context.Context, path string) (*http.Response, er
3838
return c.Client.Do(ctx, req)
3939
}
4040

41-
// NewPingAliveRequest create the request corresponding to the ping action endpoint of the alive resource.
41+
// NewPingAliveRequest creates the request corresponding to the ping action endpoint of the alive resource.
4242
func (c *Client) NewPingAliveRequest(ctx context.Context, path string) (*http.Request, error) {
4343
scheme := c.Scheme
4444
if scheme == "" {

builder_client_helpers/boards.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func (c *Client) ListBoards(ctx context.Context, path string) (*http.Response, e
3838
return c.Client.Do(ctx, req)
3939
}
4040

41-
// NewListBoardsRequest create the request corresponding to the list action endpoint of the boards resource.
41+
// NewListBoardsRequest creates the request corresponding to the list action endpoint of the boards resource.
4242
func (c *Client) NewListBoardsRequest(ctx context.Context, path string) (*http.Request, error) {
4343
scheme := c.Scheme
4444
if scheme == "" {
@@ -69,7 +69,7 @@ func (c *Client) ShowBoards(ctx context.Context, path string) (*http.Response, e
6969
return c.Client.Do(ctx, req)
7070
}
7171

72-
// NewShowBoardsRequest create the request corresponding to the show action endpoint of the boards resource.
72+
// NewShowBoardsRequest creates the request corresponding to the show action endpoint of the boards resource.
7373
func (c *Client) NewShowBoardsRequest(ctx context.Context, path string) (*http.Request, error) {
7474
scheme := c.Scheme
7575
if scheme == "" {

builder_client_helpers/boards_v2.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func ByVidPidBoardsV2Path(vid string, pid string) string {
3333
return fmt.Sprintf("/builder/v2/boards/byVidPid/%s/%s", param0, param1)
3434
}
3535

36-
// Provides the board identified by the :vid and :pid params. Doesn't require authentication.
36+
// ByVidPidBoardsV2 provides the board identified by the :vid and :pid params. Doesn't require authentication.
3737
func (c *Client) ByVidPidBoardsV2(ctx context.Context, path string) (*http.Response, error) {
3838
req, err := c.NewByVidPidBoardsV2Request(ctx, path)
3939
if err != nil {
@@ -42,7 +42,7 @@ func (c *Client) ByVidPidBoardsV2(ctx context.Context, path string) (*http.Respo
4242
return c.Client.Do(ctx, req)
4343
}
4444

45-
// NewByVidPidBoardsV2Request create the request corresponding to the byVidPid action endpoint of the boards_v2 resource.
45+
// NewByVidPidBoardsV2Request creates the request corresponding to the byVidPid action endpoint of the boards_v2 resource.
4646
func (c *Client) NewByVidPidBoardsV2Request(ctx context.Context, path string) (*http.Request, error) {
4747
scheme := c.Scheme
4848
if scheme == "" {
@@ -62,7 +62,7 @@ func ListBoardsV2Path() string {
6262
return fmt.Sprintf("/builder/v2/boards")
6363
}
6464

65-
// Provides a list of all the boards supported by Arduino Create. Doesn't require any authentication.
65+
// ListBoardsV2 provides a list of all the boards supported by Arduino Create. Doesn't require any authentication.
6666
func (c *Client) ListBoardsV2(ctx context.Context, path string, limit *int, offset *int) (*http.Response, error) {
6767
req, err := c.NewListBoardsV2Request(ctx, path, limit, offset)
6868
if err != nil {
@@ -71,7 +71,7 @@ func (c *Client) ListBoardsV2(ctx context.Context, path string, limit *int, offs
7171
return c.Client.Do(ctx, req)
7272
}
7373

74-
// NewListBoardsV2Request create the request corresponding to the list action endpoint of the boards_v2 resource.
74+
// NewListBoardsV2Request creates the request corresponding to the list action endpoint of the boards_v2 resource.
7575
func (c *Client) NewListBoardsV2Request(ctx context.Context, path string, limit *int, offset *int) (*http.Request, error) {
7676
scheme := c.Scheme
7777
if scheme == "" {
@@ -102,7 +102,7 @@ func ShowBoardsV2Path(fqbn string) string {
102102
return fmt.Sprintf("/builder/v2/boards/%s", param0)
103103
}
104104

105-
// Provides the board identified by an fqbn. Doesn't require authentication.
105+
// ShowBoardsV2 provides the board identified by an fqbn. Doesn't require authentication.
106106
func (c *Client) ShowBoardsV2(ctx context.Context, path string) (*http.Response, error) {
107107
req, err := c.NewShowBoardsV2Request(ctx, path)
108108
if err != nil {
@@ -111,7 +111,7 @@ func (c *Client) ShowBoardsV2(ctx context.Context, path string) (*http.Response,
111111
return c.Client.Do(ctx, req)
112112
}
113113

114-
// NewShowBoardsV2Request create the request corresponding to the show action endpoint of the boards_v2 resource.
114+
// NewShowBoardsV2Request creates the request corresponding to the show action endpoint of the boards_v2 resource.
115115
func (c *Client) NewShowBoardsV2Request(ctx context.Context, path string) (*http.Request, error) {
116116
scheme := c.Scheme
117117
if scheme == "" {

builder_client_helpers/compilations.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ func (c *Client) StartCompilations(ctx context.Context, path string, payload *Co
4242
return c.Client.Do(ctx, req)
4343
}
4444

45-
// NewStartCompilationsRequest create the request corresponding to the start action endpoint of the compilations resource.
45+
// NewStartCompilationsRequest creates the request corresponding to the start action endpoint of the compilations resource.
4646
func (c *Client) NewStartCompilationsRequest(ctx context.Context, path string, payload *Compilation) (*http.Request, error) {
4747
var body bytes.Buffer
4848
err := c.Encoder.Encode(payload, &body, "*/*")

builder_client_helpers/examples.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func (c *Client) ListExamples(ctx context.Context, path string, maintainer *stri
3838
return c.Client.Do(ctx, req)
3939
}
4040

41-
// NewListExamplesRequest create the request corresponding to the list action endpoint of the examples resource.
41+
// NewListExamplesRequest creates the request corresponding to the list action endpoint of the examples resource.
4242
func (c *Client) NewListExamplesRequest(ctx context.Context, path string, maintainer *string, libType *string) (*http.Request, error) {
4343
scheme := c.Scheme
4444
if scheme == "" {

builder_client_helpers/files.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func (c *Client) ShowFiles(ctx context.Context, path string) (*http.Response, er
3838
return c.Client.Do(ctx, req)
3939
}
4040

41-
// NewShowFilesRequest create the request corresponding to the show action endpoint of the files resource.
41+
// NewShowFilesRequest creates the request corresponding to the show action endpoint of the files resource.
4242
func (c *Client) NewShowFilesRequest(ctx context.Context, path string) (*http.Request, error) {
4343
scheme := c.Scheme
4444
if scheme == "" {

builder_client_helpers/libraries.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ func (c *Client) ListLibraries(
4242
return c.Client.Do(ctx, req)
4343
}
4444

45-
// NewListLibrariesRequest create the request corresponding to the list action endpoint of the libraries resource.
45+
// NewListLibrariesRequest creates the request corresponding to the list action endpoint of the libraries resource.
4646
func (c *Client) NewListLibrariesRequest(ctx context.Context, path string, maintainer *string, libType *string, withoutType *string) (*http.Request, error) {
4747
scheme := c.Scheme
4848
if scheme == "" {
@@ -73,7 +73,7 @@ func ShowLibrariesPath(id string) string {
7373
}
7474

7575
// ShowLibraries provides the library identified by the :id and :pid param. Doesn't require authentication.
76-
// Also contains a list of other versions of the library
76+
// Also contains a list of other versions of the library.
7777
func (c *Client) ShowLibraries(ctx context.Context, path string) (*http.Response, error) {
7878
req, err := c.NewShowLibrariesRequest(ctx, path)
7979
if err != nil {
@@ -82,7 +82,7 @@ func (c *Client) ShowLibraries(ctx context.Context, path string) (*http.Response
8282
return c.Client.Do(ctx, req)
8383
}
8484

85-
// NewShowLibrariesRequest create the request corresponding to the show action endpoint of the libraries resource.
85+
// NewShowLibrariesRequest creates the request corresponding to the show action endpoint of the libraries resource.
8686
func (c *Client) NewShowLibrariesRequest(ctx context.Context, path string) (*http.Request, error) {
8787
scheme := c.Scheme
8888
if scheme == "" {

builder_client_helpers/pinned_libraries.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func AddPinnedLibrariesPath(id string) string {
3131
return fmt.Sprintf("/builder/pinned/%s", param0)
3232
}
3333

34-
//AddPinnedLibraries adds a new library to the list of libraries pinned by the user
34+
// AddPinnedLibraries adds a new library to the list of libraries pinned by the user
3535
func (c *Client) AddPinnedLibraries(ctx context.Context, path string) (*http.Response, error) {
3636
req, err := c.NewAddPinnedLibrariesRequest(ctx, path)
3737
if err != nil {
@@ -40,7 +40,7 @@ func (c *Client) AddPinnedLibraries(ctx context.Context, path string) (*http.Res
4040
return c.Client.Do(ctx, req)
4141
}
4242

43-
// NewAddPinnedLibrariesRequest create the request
43+
// NewAddPinnedLibrariesRequest creates the request
4444
// corresponding to the add action endpoint of the pinnedLibraries resource.
4545
func (c *Client) NewAddPinnedLibrariesRequest(ctx context.Context, path string) (*http.Request, error) {
4646
scheme := c.Scheme
@@ -63,7 +63,7 @@ func ListPinnedLibrariesPath() string {
6363
return fmt.Sprintf("/builder/pinned")
6464
}
6565

66-
//ListPinnedLibraries provides a list of all the libraries pinned by the user
66+
// ListPinnedLibraries provides a list of all the libraries pinned by the user
6767
func (c *Client) ListPinnedLibraries(ctx context.Context, path string) (*http.Response, error) {
6868
req, err := c.NewListPinnedLibrariesRequest(ctx, path)
6969
if err != nil {
@@ -72,7 +72,7 @@ func (c *Client) ListPinnedLibraries(ctx context.Context, path string) (*http.Re
7272
return c.Client.Do(ctx, req)
7373
}
7474

75-
// NewListPinnedLibrariesRequest create the request corresponding to the list action endpoint of the pinnedLibraries resource.
75+
// NewListPinnedLibrariesRequest creates the request corresponding to the list action endpoint of the pinnedLibraries resource.
7676
func (c *Client) NewListPinnedLibrariesRequest(ctx context.Context, path string) (*http.Request, error) {
7777
scheme := c.Scheme
7878
if scheme == "" {
@@ -96,7 +96,7 @@ func RemovePinnedLibrariesPath(id string) string {
9696
return fmt.Sprintf("/builder/pinned/%s", param0)
9797
}
9898

99-
//RemovePinnedLibraries removes a library to the list of libraries pinned by the user
99+
// RemovePinnedLibraries removes a library to the list of libraries pinned by the user
100100
func (c *Client) RemovePinnedLibraries(ctx context.Context, path string) (*http.Response, error) {
101101
req, err := c.NewRemovePinnedLibrariesRequest(ctx, path)
102102
if err != nil {
@@ -105,7 +105,7 @@ func (c *Client) RemovePinnedLibraries(ctx context.Context, path string) (*http.
105105
return c.Client.Do(ctx, req)
106106
}
107107

108-
// NewRemovePinnedLibrariesRequest create the request corresponding to the remove action endpoint of the pinnedLibraries resource.
108+
// NewRemovePinnedLibrariesRequest creates the request corresponding to the remove action endpoint of the pinnedLibraries resource.
109109
func (c *Client) NewRemovePinnedLibrariesRequest(ctx context.Context, path string) (*http.Request, error) {
110110
scheme := c.Scheme
111111
if scheme == "" {

commands/commands.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ func InitPackageManager() *packagemanager.PackageManager {
105105
return pm
106106
}
107107

108-
// InitLibraryManager initialize the LibraryManager using the underlying packagemanager
108+
// InitLibraryManager initializes the LibraryManager using the underlying packagemanager
109109
func InitLibraryManager(pm *packagemanager.PackageManager) *librariesmanager.LibrariesManager {
110110
logrus.Info("Starting libraries manager")
111111
lm := librariesmanager.NewLibraryManager(

0 commit comments

Comments
 (0)