storage: transactional, package documentation

Signed-off-by: Máximo Cuadros <mcuadros@gmail.com>

1 files changed, 6 insertions, 0 deletions

diff --git a/storage/transactional/config.go b/storage/transactional/config.go
index fec1f28..4d8efe1 100644
--- a/storage/transactional/config.go
+++ b/storage/transactional/config.go
@@ -2,6 +2,7 @@ package transactional
 
 import "gopkg.in/src-d/go-git.v4/config"
 
+// ConfigStorage implements the storer.ConfigStorage for the transactional package.
 type ConfigStorage struct {
 	config.ConfigStorer
 	temporal config.ConfigStorer
@@ -9,10 +10,13 @@ type ConfigStorage struct {
 	set bool
 }
 
+// NewConfigStorage returns a new ConfigStorer based on a base storer and a
+// temporal storer.
 func NewConfigStorage(s, temporal config.ConfigStorer) *ConfigStorage {
 	return &ConfigStorage{ConfigStorer: s, temporal: temporal}
 }
 
+// SetConfig honors the storer.ConfigStorer interface.
 func (c *ConfigStorage) SetConfig(cfg *config.Config) error {
 	if err := c.temporal.SetConfig(cfg); err != nil {
 		return err
@@ -22,6 +26,7 @@ func (c *ConfigStorage) SetConfig(cfg *config.Config) error {
 	return nil
 }
 
+// Config honors the storer.ConfigStorer interface.
 func (c *ConfigStorage) Config() (*config.Config, error) {
 	if !c.set {
 		return c.ConfigStorer.Config()
@@ -30,6 +35,7 @@ func (c *ConfigStorage) Config() (*config.Config, error) {
 	return c.temporal.Config()
 }
 
+// Commit it copies the config from the temporal storage into the base storage.
 func (c *ConfigStorage) Commit() error {
 	if !c.set {
 		return nil