Updated all doc.go files to latest status, should reflect pluto's current capabilities now.

Author: numbleroot

auth/doc.go

@@ -1,7 +1,8 @@
 /*
 Package auth defines potentially multiple mechanisms to determine whether supplied
-user credentials via an IMAP session can be found in a defined user information system.
-Examples include an authenticator based on a user database in a PostgreSQL database and
-a simple lookup function if username and password match.
+user credentials in an IMAP session can be found in a defined user information system.
+Examples include an authenticator based on a user table in a PostgreSQL database and
+a simple (potentially insecure) plain user text file. It is easily possible to implement
+new authenticators that fit specific requirements.
 */
 package auth

comm/doc.go

@@ -1,5 +1,8 @@
 /*
-Package comm implements network communication that is reliable and causally-ordered to
-a group of nodes and respective receiving parts.
+Package comm implements network communication capabilities that are reliable and
+causally-ordered among multiple nodes. Vector clocks are used to ensure causality.
+Currently, communication is blocking on a sending node that fails to deliver an
+earlier message. Numerous message formats and required parses are provided to
+transform received marshalled CRDT messages into structured ones.
 */
 package comm

config/doc.go

@@ -1,5 +1,5 @@
 /*
 Package config provides functions to read in various configuration files into definded types.
-This includes the main configuration file specifying all details about the distributed setup of pluto.
+This includes the main configuration file specifying all details about a distributed setup of pluto.
 */
 package config

crdt/doc.go

@@ -1,11 +1,11 @@
 /*
-Package crdt implements the needed operation-based observed-removed set (ORSet) structure
-upon that the CmRDT parts of pluto are built. Please note, that for correct operation
+Package crdt implements the operation-based observed-removed set (ORSet) structure
+upon that the CmRDT parts of pluto are built. Please note that for correct operation
 and results we expect the broadcast communication to all other replicas to be reliable
-and causally-ordered.
+and causally-ordered as provided by pluto's package comm.
 
-The operation-based ORSet implementation of this package is a practical derivation from
-its specification by Shapiro, Preguiça, Baquero and Zawirski, available under:
+The operation-based ORSet implementation of this package is a practical derivation
+from its specification by Shapiro, Preguiça, Baquero and Zawirski, available under:
 https://hal.inria.fr/inria-00555588/document
 */
 package crdt

crypto/doc.go

@@ -1,6 +1,7 @@
 /*
-Package crypto provides the basis for secure communication in pluto. Other than making proper TLS
-configurations for public as well as internal usage available, it also provides a script to set up
-the needed internal PKI for secure and authenticated communication between pluto's nodes.
+Package crypto provides the basis for secure communication in pluto. Other than defining
+proper TLS configurations for public as well as internal use, it also provides a script
+to set up major parts of a PKI used internally for secure and authenticated communication
+among the pluto nodes.
 */
 package crypto

imap/doc.go

@@ -1,16 +1,16 @@
 /*
-Package imap implements all three node types a pluto setup consists of: a distributor node,
-multiple worker nodes and a storage node.
+Package imap implements all three node types a pluto setup consists of: distributor, worker,
+and storage.
 
 Handler functions for the various implemented IMAP commands usually return a boolean value
 indicating whether correct communication between pluto and connected clients was achieved
-but not whether commands could been handled correct according to IMAP semantics. This means,
-that if a fatal error occurred during handling e.g. a LOGIN request which prevents the system
-with a high probability to handle future commands correctly as well, the responsible handler
-function would return false. But in case an user error occurred such as a missing name and/or
+but not whether commands were handled correctly according to IMAP semantics. This means that
+if a fatal error occurred during handling e.g. a LOGIN request which prevents the system with
+a high probability from handling future commands correctly as well, the responsible handler
+function will return false. But in case an user error occurred such as a missing name and/or
 password accompanying the LOGIN command and pluto was able to send back a useful error message
-to the client, this function would still return true because communications went according to
-planned handling pipeline.
+to the client, this function returns true because communication went according to planned
+handling pipeline.
 
 Please refer to https://tools.ietf.org/html/rfc3501#section-3 for full documentation
 on the states and https://tools.ietf.org/html/rfc3501 for the full IMAP v4 rev1 RFC.

utils/doc.go

@@ -1,5 +1,5 @@
 /*
 Package utils provides smaller and independent helper functions which are needed
-at various places throughout the code base.
+in various places throughout the code base.
 */
 package utils