diff options
author | xegineering <me@xegineering.eu> | 2024-10-02 21:18:51 +0200 |
---|---|---|
committer | xegineering <me@xegineering.eu> | 2024-10-02 21:18:51 +0200 |
commit | 07741b358ba75350e7be36ee76f45afa18b0461b (patch) | |
tree | e9dccde0151f9afdc8703c09f665d043149ddce7 /examples_test.go | |
parent | cdd23b4b0a7c14dba738f035e75ac640f1ca3e85 (diff) | |
download | soundbox-go-07741b358ba75350e7be36ee76f45afa18b0461b.tar soundbox-go-07741b358ba75350e7be36ee76f45afa18b0461b.tar.zst soundbox-go-07741b358ba75350e7be36ee76f45afa18b0461b.zip |
Rename Soundbox to Client
Since the module name is `soundbox` naming the primary type of the
module also `Soundbox` is redundant. Following similar code from the Go
standard library this struct is renamed to `Client`.
Diffstat (limited to 'examples_test.go')
-rw-r--r-- | examples_test.go | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/examples_test.go b/examples_test.go index 1320cd6..777ae52 100644 --- a/examples_test.go +++ b/examples_test.go @@ -7,15 +7,15 @@ import ( "xengineering.eu/soundbox" ) -// ExampleSoundbox demonstrates how to instantiate a Soundbox struct. The used -// MAC address if from a private range according to +// ExampleClient demonstrates how to instantiate a Client struct. The used MAC +// address if from a private range according to // https://www.rfc-editor.org/rfc/rfc9542.html#name-48-bit-mac-documentation-va. -func ExampleSoundbox() { - s, err := soundbox.NewSoundbox("00:00:5E:00:53:01") +func ExampleClient() { + s, err := soundbox.NewClient("00:00:5E:00:53:01") if err != nil { log.Fatal(err) } - fmt.Printf("Soundbox with MAC address %v", s.HardwareAddr) - // Output: Soundbox with MAC address 00:00:5e:00:53:01 + fmt.Printf("Client with MAC address %v", s.HardwareAddr) + // Output: Client with MAC address 00:00:5e:00:53:01 } |