Skip to content

Commit

Permalink
Improve documentation for String methods
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
wneessen committed Oct 6, 2024
1 parent 2c1082f commit dab9cc9
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions encoding.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}

0 comments on commit dab9cc9

Please sign in to comment.