docs: improve documentation and testing across multiple modules

- Add usage comments for DefaultHeaderTransport in client.go
- Add args and returns comments for IsCommandAvailable function in util.go

Signed-off-by: appleboy <[email protected]>

Author: appleboy

provider/openai/client.go

@@ -14,14 +14,15 @@ type DefaultHeaderTransport struct {
 // RoundTrip implements the http.RoundTripper interface.
 // It adds the headers from DefaultHeaderTransport to the request before sending it.
 // Usage:
-//   transport := &DefaultHeaderTransport{
-//       Origin: http.DefaultTransport,
-//       Header: http.Header{
-//           "Authorization": {"Bearer token"},
-//       },
-//   }
-//   client := &http.Client{Transport: transport}
-//   resp, err := client.Get("https://example.com")
+//
+//	transport := &DefaultHeaderTransport{
+//	    Origin: http.DefaultTransport,
+//	    Header: http.Header{
+//	        "Authorization": {"Bearer token"},
+//	    },
+//	}
+//	client := &http.Client{Transport: transport}
+//	resp, err := client.Get("https://example.com")
 func (t *DefaultHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error) {
 	for key, values := range t.Header {
 		for _, value := range values {
@@ -35,9 +36,10 @@ func (t *DefaultHeaderTransport) RoundTrip(req *http.Request) (*http.Response, e
 // Each header in the slice should be in the format "key=value".
 // If a header is not in the correct format, it is skipped.
 // Usage:
-//   headers := []string{"Authorization=Bearer token", "Content-Type=application/json"}
-//   httpHeaders := NewHeaders(headers)
-//   fmt.Println(httpHeaders.Get("Authorization")) // Output: Bearer token
+//
+//	headers := []string{"Authorization=Bearer token", "Content-Type=application/json"}
+//	httpHeaders := NewHeaders(headers)
+//	fmt.Println(httpHeaders.Get("Authorization")) // Output: Bearer token
 func NewHeaders(headers []string) http.Header {
 	h := make(http.Header)
 	for _, header := range headers {

util/util.go

@@ -19,10 +19,12 @@ func IsCommandAvailable(cmd string) bool {
 // The resulting map contains the keys and values from the input slice.
 //
 // Args:
-//   args ([]string): A slice of strings where each string is in the format "key=value".
+//
+//	args ([]string): A slice of strings where each string is in the format "key=value".
 //
 // Returns:
-//   Data: A map where the keys and values are derived from the input slice.
+//
+//	Data: A map where the keys and values are derived from the input slice.
 func ConvertToMap(args []string) Data {
 	m := make(Data)
 	for _, arg := range args {