v1.0.1

FIX:
* Cleaned up some documentation

consts.go

@@ -12,11 +12,14 @@ var (
 )
 
 const (
+	// IndentDefault is the [IndentChars] to use if not specified.
 	IndentDefault    string = "\t"
+	// SeperatorDefault is the [SeperatorChars] to use if not specified.
 	SeparatorDefault string = "   "
-	maxByteLine      int    = 12 // split if a value is more than this number of bytes..
+	maxByteLine      int    = 12 // (Split a hex string in a Model if a value is more than this number of bytes.)
 )
 
+// Default indent levels.
 const (
 	indentR uint = iota
 	indentRG
@@ -26,18 +29,18 @@ const (
 const indentOrigRec uint = 2
 
 const (
-	// ProtoVersion specifies the protocol version for the specification of a Message.
+	// ProtoVersion specifies the protocol version for the specification of a [Message].
 	ProtoVersion uint32 = 1
 )
 
 const (
 	// PackedNumSize is the size (length of bytes) of a packed unsigned integer.
-	PackedNumSize int = 4 // They're all uint32's.
+	PackedNumSize int = 4 // (They're all uint32's.)
 	// CksumPackedSize is the size (length of bytes) of the checksum algorithm used.
-	CksumPackedSize int = 4 // CRC32 is a big-endian uint32, but if we use a different algo we need to change this.
+	CksumPackedSize int = 4 // CRC32 is represented by a big-endian uint32, but if a different algo is used, this will need to be changed.
 )
 
-// See https://square-r00t.net/ascii.html for further details.
+// See https://square-r00t.net/ascii.html for further details on ASCII symbols.
 const (
 	AsciiNUL uint8 = iota // 0x00
 	AsciiSOH              // 0x01
@@ -73,6 +76,7 @@ const (
 	AsciiUS               // 0x1f
 )
 
+// Response Status indicator bytes.
 const (
 	RespStatusByteOK  uint8 = AsciiACK
 	RespStatusByteErr       = AsciiNAK
@@ -95,5 +99,6 @@ var (
 )
 
 const (
+	// WriteChunkSize is the default size of chunking to use (in bytes) when using chunked Write* functions (i.e. non-segmented).
 	WriteChunkSize int = 1024
 )