Add/improve godoc descriptions for some modules.

License: MIT
Signed-off-by: Hector Sanjuan <code@hector.link>

adder/adder.go

@@ -1,3 +1,5 @@
+// Package adder implements functionality to add content to IPFS daemons
+// managed by the Cluster.
 package adder
 
 import (

api/rest/client/client.go

@@ -1,3 +1,6 @@
+// Package client provides a Go Client for the IPFS Cluster API provided
+// by the "api/rest" component. It supports both the HTTP(s) endpoint and
+// the libp2p-http endpoint.
 package client
 
 import (

config/config.go

@@ -1,3 +1,6 @@
+// Package config provides interfaces and utilities for different Cluster
+// components to register, read,  write and validate configuration sections
+// stored in a central configuration file.
 package config
 
 import (

ipfs-cluster-ctl/main.go

@@ -1,3 +1,4 @@
+// The ipfs-cluster-ctl application.
 package main
 
 import (

ipfs-cluster-service/lock.go

@@ -1,4 +1,3 @@
-// lock logic heavily inspired by go-ipfs/repo/fsrepo/lock/lock.go
 package main
 
 import (
@@ -10,6 +9,8 @@ import (
 	fslock "github.com/ipfs/go-fs-lock"
 )
 
+// lock logic heavily inspired by go-ipfs/repo/fsrepo/lock/lock.go
+
 // The name of the file used for locking
 const lockFileName = "cluster.lock"
 

ipfs-cluster-service/main.go

@@ -1,3 +1,4 @@
+// The ipfs-cluster-service application.
 package main
 
 import (

pintracker/stateless/stateless.go

@@ -1,3 +1,6 @@
+// Package stateless implements a PinTracker component for IPFS Cluster, which
+// aims to reduce the memory footprint when handling really large cluster
+// states.
 package stateless
 
 import (

test/test.go

@@ -1,3 +1,3 @@
-// Package test offers testing utilities to ipfs-cluster like
-// mocks
+// Package test offers testing utilities for all the IPFS Cluster
+// codebase, like IPFS daemon and RPC mocks and pre-defined testing CIDs.
 package test