Skip to content

Commit 90b3d0f

Browse files
v1defv1def
committed
style: change comment line height
1 parent 1191b49 commit 90b3d0f

28 files changed

+95
-120
lines changed

‎.github/workflows/test.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
# Copyright © 2022 Durudex
2-
#
3-
# This source code is licensed under the MIT license found in the
4-
# LICENSE file in the root directory of this source tree.
5-
61
on:
72
push:
83
branches:

‎.gitignore

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1 @@
1-
# Copyright © 2022 Durudex
2-
#
3-
# This source code is licensed under the MIT license found in the
4-
# LICENSE file in the root directory of this source tree.
5-
61
.DS_Store

‎client.go

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2022-2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package polybase
@@ -16,20 +16,22 @@ import (
1616
)
1717

1818
const (
19-
// The ClientHeaderKey constant stores the value of the client key for an HTTP header.
19+
// The ClientHeaderKey constant stores the value of the client key for
20+
// an HTTP header.
2021
ClientHeaderKey = "X-Polybase-Client"
2122

22-
// The clientHeaderPrefix constant stores the value of the client prefix for an HTTP header.
23-
// This value is added to the beginning of the client name specified in the configuration.
23+
// The clientHeaderPrefix constant stores the value of the client prefix
24+
// for an HTTP header. This value is added to the beginning of the client
25+
// name specified in the configuration.
2426
//
2527
// Example: "durudex/go-polybase:default-name"
2628
clientHeaderPrefix = "durudex/go-polybase:"
2729
)
2830

2931
// Client interface stores methods for interaction with Polybase Node.
3032
type Client interface {
31-
// MakeRequest method makes a request with the specified settings and decodes
32-
// the JSON response.
33+
// MakeRequest method makes a request with the specified settings and
34+
// decodes the JSON response.
3335
MakeRequest(ctx context.Context, req *Request, resp any) error
3436

3537
Config() *Config
@@ -67,20 +69,23 @@ type client struct {
6769
doer *http.Client
6870
}
6971

70-
// To start using the go-polybase client, you need to crete a new client instance. This can be
71-
// done using the internal New() function, which returns a new instance with either a specified
72-
// configuration or the default configuration.
72+
// To start using the go-polybase client, you need to crete a new client
73+
// instance. This can be done using the internal New() function, which
74+
// returns a new instance with either a specified configuration or the
75+
// default configuration.
7376
//
74-
// To create an instance with a specified configuration, you need to pass a pointer of Config
75-
// value as an argument to the New(...) function. This can be useful if you want to use specific
76-
// settings, for example, if you have your own configuration file.
77+
// To create an instance with a specified configuration, you need to pass
78+
// a pointer of Config value as an argument to the New(...) function. This
79+
// can be useful if you want to use specific settings, for example, if you
80+
// have your own configuration file.
7781
//
7882
// client := polybase.New(&polybase.Config{
7983
// ...
8084
// }
8185
//
82-
// If you want to use the default configuration, you can simply call the New() function without any
83-
// arguments. The client will be created with the default configuration set in the go-polybase module.
86+
// If you want to use the default configuration, you can simply call the New()
87+
// function without any arguments. The client will be created with the default
88+
// configuration set in the go-polybase module.
8489
//
8590
// client := polybase.New()
8691
func New(configs ...*Config) Client {
@@ -97,7 +102,8 @@ func New(configs ...*Config) Client {
97102
return &client{cfg: cfg, doer: http.DefaultClient}
98103
}
99104

100-
// MakeRequest method makes a request with the specified settings and decodes the JSON response.
105+
// MakeRequest method makes a request with the specified settings and decodes
106+
// the JSON response.
101107
func (c *client) MakeRequest(ctx context.Context, req *Request, resp any) error {
102108
// Creating a new HTTP request.
103109
rwc, err := c.newRequest(ctx, req)

‎client_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package polybase_test

‎collection.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2022-2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package polybase

‎config.go

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,51 @@
11
/*
22
* Copyright © 2022-2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package polybase
99

10-
// The constant DefaultName contains the default client name, which is used as the value of
11-
// the 'X-Polybase-Client' HTTP header.
10+
// The constant DefaultName contains the default client name, which is used
11+
// as the value of the 'X-Polybase-Client' HTTP header.
1212
const DefaultName = "default"
1313

14-
// The Config structure defines the configuration used to set up the go-polybase client.
14+
// The Config structure defines the configuration used to set up the
15+
// go-polybase client.
1516
type Config struct {
16-
// The URL field defines a url to a node or any other Polybase API gateway to which the
17-
// client will send requests. You can use pre-defined internal url values or specify your
18-
// own url values.
17+
// The URL field defines a url to a node or any other Polybase API gateway
18+
// to which the client will send requests. You can use pre-defined internal
19+
// url values or specify your own url values.
1920
//
2021
// Internal values:
2122
//
2223
// - DefaultURL (Default)
2324
// - TestnetURL
2425
URL string `json:"url"`
2526

26-
// The Name field defines the client name used as the value of the 'X-Polybase-Client' HTTP
27-
// header in requests to the Polybase API.
27+
// The Name field defines the client name used as the value of the
28+
// 'X-Polybase-Client' HTTP header in requests to the Polybase API.
2829
//
29-
// Additionally, for better analysis, the prefix "durudex/go-polybase:" is added to each name.
30-
// This allows for easier identification of the module or library from which requests are made.
30+
// Additionally, for better analysis, the prefix "durudex/go-polybase:"
31+
// is added to each name. This allows for easier identification of the
32+
// module or library from which requests are made.
3133
//
3234
// Optional. Default DefaultName.
3335
Name string `json:"name"`
3436

35-
// The DefaultNamespace field defines the default namespace that will be added to the
36-
// collection name when creating a new instance.
37+
// The DefaultNamespace field defines the default namespace that will
38+
// be added to the collection name when creating a new instance.
3739
//
3840
// Optional.
3941
DefaultNamespace string `json:"defaultName"`
4042

41-
// The RecoverHandler field defines the handler that will be called in case of a panic.
43+
// The RecoverHandler field defines the handler that will be called in
44+
// case of a panic.
4245
//
43-
// Panics usually occur during development and may indicate passing an incorrect type or a lack
44-
// of connection to the internet or the Polybase API.
46+
// Panics usually occur during development and may indicate passing an
47+
// incorrect type or a lack of connection to the internet or the Polybase
48+
// API.
4549
//
4650
// Optional. Default DefaultRecover.
4751
RecoverHandler RecoverHandler `json:"-"`

‎error.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2022-2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package polybase

‎examples/call/main.go

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
/*
2-
* Copyright © 2022-2023 Durudex
3-
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
6-
*/
7-
81
package main
92

103
import (

‎examples/create/main.go

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
/*
2-
* Copyright © 2022-2023 Durudex
3-
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
6-
*/
7-
81
package main
92

103
import (

‎examples/multiple/main.go

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
/*
2-
* Copyright © 2022-2023 Durudex
3-
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
6-
*/
7-
81
package main
92

103
import (

‎examples/single/main.go

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
/*
2-
* Copyright © 2022-2023 Durudex
3-
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
6-
*/
7-
81
package main
92

103
import (

‎input/array.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input

‎input/array_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input_test

‎input/foreign.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input

‎input/foreign_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input_test

‎input/input.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input

‎input/input_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input_test

‎input/kind.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input

‎input/map.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input

‎input/map_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input_test

‎input/pointer.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input

‎input/pointer_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input_test

‎input/struct.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input

‎input/struct_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
* Copyright © 2023 Durudex
33
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
4+
* This source code is licensed under the MIT license found in the LICENSE
5+
* file in the root directory of this source tree.
66
*/
77

88
package input_test

0 commit comments

Comments
 (0)