Fix lint problems, add some explanations in the docstrings

.golangci.yml

@@ -87,3 +87,5 @@ issues:
   # excluded by default patterns execute `golangci-lint run --help`
   exclude:
      - Using the variable on range scope `tt` in function literal
+     - "var-naming: don't use underscores in Go names; method Kaitai_IO should be KaitaiIO"
+     - "ST1003: should not use underscores in Go names; method Kaitai_IO should be KaitaiIO"

kaitai/struct.go

@@ -1,7 +1,12 @@
 package kaitai
 
-// Struct is the common interface guaranteed to be implemented by all types generated
-// by Kaitai Struct compiler.
+// Struct is the common interface guaranteed to be implemented by all types generated by
+// Kaitai Struct compiler.
 type Struct interface {
+	// Kaitai_IO returns the stream object associated with the struct.
+	//
+	// This is deliberately named with a `Kaitai_` prefix and underscore to avoid conflicts
+	// with other methods that may result from the attributes in Kaitai Struct type, e.g.
+	// is a user will define attribute `i_o` this will conflict with the method `IO()`.
 	Kaitai_IO() *Stream
 }

kaitai/struct_test.go

@@ -3,6 +3,7 @@ package kaitai
 import (
 	"bytes"
 	"testing"
+
 	"github.com/stretchr/testify/assert"
 )
 
@@ -25,7 +26,8 @@ func (s *twoStruct) Kaitai_IO() *Stream {
 	return s._io
 }
 
-func WorkWithStruct(s Struct, t *testing.T, expectedSize int) {
+func WorkWithStruct(t *testing.T, s Struct, expectedSize int) {
+	t.Helper()
 	actualSize, err := s.Kaitai_IO().Size()
 	assert.Nil(t, err)
 	assert.Equal(t, actualSize, int64(expectedSize))
@@ -41,6 +43,6 @@ func TestKaitaiStruct(t *testing.T) {
 	two := twoStruct{222, twoStream}
 
 	// Check if the structs implement the Struct interface
-	WorkWithStruct(&one, t, 7)
-	WorkWithStruct(&two, t, 9)
+	WorkWithStruct(t, &one, 7)
+	WorkWithStruct(t, &two, 9)
 }