From dab9cc947a831181ba7e9a0f2277941ad3e7f153 Mon Sep 17 00:00:00 2001
From: Winni Neessen <wn@neessen.net>
Date: Sun, 6 Oct 2024 13:53:20 +0200
Subject: [PATCH] Improve documentation for String methods

Enhanced comments for String methods on Charset, ContentType, and Encoding types. Detailed the purpose and usage of each method, emphasizing their role in formatted output and logging.
---
 encoding.go | 28 ++++++++++++++++++++++++----
 1 file changed, 24 insertions(+), 4 deletions(-)

diff --git a/encoding.go b/encoding.go
index 2b559c4..9ed5666 100644
--- a/encoding.go
+++ b/encoding.go
@@ -184,18 +184,38 @@ const (
 	MIMERelated MIMEType = "related"
 )
 
-// String satisfies the fmt.Stringer interface for the Charset type. It converts a Charset into a printable format.
+// String satisfies the fmt.Stringer interface for the Charset type.
+// It converts a Charset into a printable format.
+//
+// This method returns the string representation of the Charset, allowing it to be easily
+// printed or logged.
+//
+// Returns:
+//   - A string representation of the Charset.
 func (c Charset) String() string {
 	return string(c)
 }
 
-// String satisfies the fmt.Stringer interface for the ContentType type. It converts a ContentType into a printable
-// format.
+// String satisfies the fmt.Stringer interface for the ContentType type.
+// It converts a ContentType into a printable format.
+//
+// This method returns the string representation of the ContentType, enabling its use
+// in formatted output such as logging or displaying information to the user.
+//
+// Returns:
+//   - A string representation of the ContentType.
 func (c ContentType) String() string {
 	return string(c)
 }
 
-// String satisfies the fmt.Stringer interface for the Encoding type. It converts an Encoding into a printable format.
+// String satisfies the fmt.Stringer interface for the Encoding type.
+// It converts an Encoding into a printable format.
+//
+// This method returns the string representation of the Encoding, which can be used
+// for displaying or logging purposes.
+//
+// Returns:
+//   - A string representation of the Encoding.
 func (e Encoding) String() string {
 	return string(e)
 }