From 1d7db9ceee37331b2280b803fca374d055c4ffe6 Mon Sep 17 00:00:00 2001
From: Mickael Remond <mremond@process-one.net>
Date: Mon, 4 Nov 2019 12:58:10 +0100
Subject: [PATCH] Comments clean-up

---
 config.go        |  4 ++--
 stream_logger.go | 18 +++++++++---------
 transport.go     |  1 +
 3 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/config.go b/config.go
index 6e836da..e3ea108 100644
--- a/config.go
+++ b/config.go
@@ -4,9 +4,9 @@ import (
 	"os"
 )
 
+// Config & TransportConfiguration must not be modified after having been passed to NewClient. Any
+// changes made after connecting are ignored.
 type Config struct {
-	// TransportConfiguration must not be modified after having been passed to NewClient. Any
-	// changes made after connecting are ignored.
 	TransportConfiguration
 
 	Jid            string
diff --git a/stream_logger.go b/stream_logger.go
index 154dc87..0e6cc7b 100644
--- a/stream_logger.go
+++ b/stream_logger.go
@@ -19,21 +19,21 @@ func newStreamLogger(conn io.ReadWriter, logFile io.Writer) io.ReadWriter {
 	}
 }
 
-func (sp *streamLogger) Read(p []byte) (n int, err error) {
-	n, err = sp.socket.Read(p)
+func (sl *streamLogger) Read(p []byte) (n int, err error) {
+	n, err = sl.socket.Read(p)
 	if n > 0 {
-		sp.logFile.Write([]byte("RECV:\n")) // Prefix
-		if n, err := sp.logFile.Write(p[:n]); err != nil {
+		sl.logFile.Write([]byte("RECV:\n")) // Prefix
+		if n, err := sl.logFile.Write(p[:n]); err != nil {
 			return n, err
 		}
-		sp.logFile.Write([]byte("\n\n")) // Separator
+		sl.logFile.Write([]byte("\n\n")) // Separator
 	}
 	return
 }
 
-func (sp *streamLogger) Write(p []byte) (n int, err error) {
-	sp.logFile.Write([]byte("SEND:\n")) // Prefix
-	for _, w := range []io.Writer{sp.socket, sp.logFile} {
+func (sl *streamLogger) Write(p []byte) (n int, err error) {
+	sl.logFile.Write([]byte("SEND:\n")) // Prefix
+	for _, w := range []io.Writer{sl.socket, sl.logFile} {
 		n, err = w.Write(p)
 		if err != nil {
 			return
@@ -43,7 +43,7 @@ func (sp *streamLogger) Write(p []byte) (n int, err error) {
 			return
 		}
 	}
-	sp.logFile.Write([]byte("\n\n")) // Separator
+	sl.logFile.Write([]byte("\n\n")) // Separator
 	return len(p), nil
 }
 
diff --git a/transport.go b/transport.go
index 22006c9..c6134fb 100644
--- a/transport.go
+++ b/transport.go
@@ -12,6 +12,7 @@ import (
 var ErrTransportProtocolNotSupported = errors.New("Transport protocol not supported")
 var ErrTLSNotSupported = errors.New("Transport does not support StartTLS")
 
+// TODO: rename to transport config?
 type TransportConfiguration struct {
 	// Address is the XMPP Host and port to connect to. Host is of
 	// the form 'serverhost:port' i.e "localhost:8888"