From 07741b358ba75350e7be36ee76f45afa18b0461b Mon Sep 17 00:00:00 2001 From: xegineering Date: Wed, 2 Oct 2024 21:18:51 +0200 Subject: 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`. --- examples_test.go | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'examples_test.go') 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 } -- cgit v1.2.3-70-g09d2