Merge lp:~teknico/ubuntu-push/reflow-docs into lp:ubuntu-push

[Nicola Larosa]

Reflow comments so that subsequent changes are more readable. Only comment reflows, no other changes.

Reflow comments so that subsequent changes are more readable. Only comment reflows, no other changes.

[Samuele Pedroni (pedronis)]

review: Approve

=== modified file 'bus/connectivity/connectivity.go'
--- bus/connectivity/connectivity.go	2014-02-06 07:59:27 +0000
+++ bus/connectivity/connectivity.go	2014-02-21 16:21:03 +0000
@@ -14,8 +14,8 @@
  with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-// Package connectivity a single, simple stream of booleans to answer
-// the quesiton “are we connected?”.
+// Package connectivity a single, simple stream of booleans
+// to answer the quesiton “are we connected?”.
 //
 // It can potentially fire two falses in a row, if a disconnected
 // state is followed by a dbus watch error. Other than that, it's edge
@@ -32,8 +32,7 @@
 	"time"
 )
 
-// the configuration for ConnectedState, with the idea that you'd populate it
-// from a config file.
+// the configuration for ConnectedState, with the idea that you'd populate it from a config file.
 type ConnectivityConfig struct {
 	// how long to wait after a state change to make sure it's "stable"
 	// before acting on it

=== modified file 'protocol/protocol.go'
--- protocol/protocol.go	2014-01-28 22:18:39 +0000
+++ protocol/protocol.go	2014-02-21 16:21:03 +0000
@@ -27,7 +27,8 @@
 	"time"
 )
 
-// Protocol is a connection capable of writing and reading the wire format of protocol messages.
+// Protocol is a connection capable of writing and reading the wire format
+// of protocol messages.
 type Protocol interface {
 	SetDeadline(t time.Time)
 	ReadMessage(msg interface{}) error
@@ -71,7 +72,8 @@
 	}
 }
 
-// ReadMessage reads one message made of big endian uint16 length, JSON body of length from the connection.
+// ReadMessage reads one message made of big endian uint16 length, JSON body
+// of length from the connection.
 func (c *protocol0) ReadMessage(msg interface{}) error {
 	c.buffer.Reset()
 	_, err := io.CopyN(c.buffer, c.conn, 2)
@@ -87,7 +89,8 @@
 	return json.Unmarshal(c.buffer.Bytes(), msg)
 }
 
-// WriteMessage writes one message made of big endian uint16 length, JSON body of length to the connection.
+// WriteMessage writes one message made of big endian uint16 length, JSON body
+// of length to the connection.
 func (c *protocol0) WriteMessage(msg interface{}) error {
 	c.buffer.Reset()
 	c.buffer.WriteString("\x00\x00") // placeholder for length

=== modified file 'server/broker/broker.go'
--- server/broker/broker.go	2014-02-10 23:19:08 +0000
+++ server/broker/broker.go	2014-02-21 16:21:03 +0000
@@ -25,7 +25,8 @@
 	"launchpad.net/ubuntu-push/server/store"
 )
 
-// Broker is responsible for registring sessions and delivering messages through them.
+// Broker is responsible for registring sessions and delivering messages
+// through them.
 type Broker interface {
 	// Register the session.
 	Register(*protocol.ConnectMsg) (BrokerSession, error)

=== modified file 'server/broker/simple/simple.go'
--- server/broker/simple/simple.go	2014-02-10 23:19:08 +0000
+++ server/broker/simple/simple.go	2014-02-21 16:21:03 +0000
@@ -26,7 +26,8 @@
 	"launchpad.net/ubuntu-push/server/store"
 )
 
-// SimpleBroker implements broker.Broker/BrokerSending for everything in just one process.
+// SimpleBroker implements broker.Broker/BrokerSending for everything
+// in just one process.
 type SimpleBroker struct {
 	sto    store.PendingStore
 	logger logger.Logger

=== modified file 'server/doc.go'
--- server/doc.go	2014-01-23 15:33:30 +0000
+++ server/doc.go	2014-02-21 16:21:03 +0000
@@ -14,5 +14,6 @@
  with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-// Package server contains code to start server components hosted by the subpackages.
+// Package server contains code to start server components hosted
+// by the subpackages.
 package server

=== modified file 'server/listener/listener.go'
--- server/listener/listener.go	2014-02-10 23:19:08 +0000
+++ server/listener/listener.go	2014-02-21 16:21:03 +0000
@@ -14,7 +14,8 @@
  with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-// Package listener has code to listen for device connections and setup sessions for them.
+// Package listener has code to listen for device connections
+// and setup sessions for them.
 package listener
 
 import (

=== modified file 'testing/helpers.go'
--- testing/helpers.go	2014-02-10 23:32:48 +0000
+++ testing/helpers.go	2014-02-21 16:21:03 +0000
@@ -73,7 +73,8 @@
 	helper *captureHelper
 }
 
-// NewTestLogger can be used in tests instead of NewSimpleLogger(FromMinimalLogger).
+// NewTestLogger can be used in tests instead of
+// NewSimpleLogger(FromMinimalLogger).
 func NewTestLogger(minLog logger.MinimalLogger, level string) *TestLogger {
 	h := &captureHelper{outputFunc: minLog.Output}
 	log := &TestLogger{