ethclient: improve documentation comments

README.md

@@ -254,3 +254,5 @@ also included in our repository in the `COPYING.LESSER` file.
 The go-ethereum binaries (i.e. all code inside of the `cmd` directory) are licensed under the
 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also
 included in our repository in the `COPYING` file.
+
+Small documentation improvement for contribution testing.

build/ci.go

@@ -343,7 +343,7 @@ func buildFlags(env build.Environment, staticLinking bool, buildTags []string) (
 		}
 		ld = append(ld, "-extldflags", "'"+strings.Join(extld, " ")+"'")
 	}
-    // TODO(gballet): revisit after the input api has been defined
+	// TODO(gballet): revisit after the input api has been defined
 	if runtime.GOARCH == "wasm" {
 		ld = append(ld, "-gcflags=all=-d=softfloat")
 	}

ethclient/ethclient.go

@@ -37,12 +37,13 @@ type Client struct {
 	c *rpc.Client
 }
 
-// Dial connects a client to the given URL.
+// Dial creates a new RPC client and connects to the given URL endpoint.
 func Dial(rawurl string) (*Client, error) {
 	return DialContext(context.Background(), rawurl)
 }
 
-// DialContext connects a client to the given URL with context.
+// DialContext creates a new RPC client using the provided context
+// and connects it to the specified URL endpoint.
 func DialContext(ctx context.Context, rawurl string) (*Client, error) {
 	c, err := rpc.DialContext(ctx, rawurl)
 	if err != nil {
@@ -51,17 +52,17 @@ func DialContext(ctx context.Context, rawurl string) (*Client, error) {
 	return NewClient(c), nil
 }
 
-// NewClient creates a client that uses the given RPC client.
+// NewClient creates a Client instance that wraps the provided RPC client.
 func NewClient(c *rpc.Client) *Client {
 	return &Client{c}
 }
 
-// Close closes the underlying RPC connection.
+// Close terminates the underlying RPC connection.
 func (ec *Client) Close() {
 	ec.c.Close()
 }
 
-// Client gets the underlying RPC client.
+// Client returns the underlying RPC client instance.
 func (ec *Client) Client() *rpc.Client {
 	return ec.c
 }