update docs

Author: emar-kar

chainmap/chainmap.go

@@ -1,11 +1,14 @@
 package chainmap
 
+// Dict is a simple string->string map.
 type Dict map[string]string
 
+// ChainMap contains a slice of Dicts for interpolation values.
 type ChainMap struct {
 	maps []Dict
 }
 
+// New creates a new ChainMap.
 func New(dicts ...Dict) *ChainMap {
 	chainMap := &ChainMap{
 		maps: make([]Dict, 0),
@@ -15,14 +18,18 @@ func New(dicts ...Dict) *ChainMap {
 	return chainMap
 }
 
+// Add adds given dicts to the ChainMap.
 func (c *ChainMap) Add(dicts ...Dict) {
 	c.maps = append(c.maps, dicts...)
 }
 
+// Len returns the ammount of Dicts in the ChainMap.
 func (c *ChainMap) Len() int {
 	return len(c.maps)
 }
 
+// Get gets the last value with the given key from the ChainMap.
+// If key does not exist returns empty string.
 func (c *ChainMap) Get(key string) string {
 	var value string
 

methods.go

@@ -79,9 +79,9 @@ func (p *ConfigParser) Options(section string) ([]string, error) {
 
 // Get returns string value for the named option.
 //
-// Returns an error if a section does not exist
+// Returns an error if a section does not exist.
 // Returns an error if the option does not exist either in the section or in
-// the defaults
+// the defaults.
 func (p *ConfigParser) Get(section, option string) (string, error) {
 	fn, ok := p.opt.converters["string"]
 	returnFunc := func(v string) (string, error) {
@@ -174,6 +174,11 @@ func (p *ConfigParser) Set(section, option, value string) error {
 	return setSection.Add(option, value)
 }
 
+// GetInt64 returns int64 representation of the named option.
+//
+// Returns an error if a section does not exist.
+// Returns an error if the option does not exist either in the section or in
+// the defaults.
 func (p *ConfigParser) GetInt64(section, option string) (int64, error) {
 	result, err := p.get(section, option)
 	if err != nil {
@@ -198,6 +203,11 @@ func (p *ConfigParser) GetInt64(section, option string) (int64, error) {
 	return int64(value.(int)), nil
 }
 
+// GetFloat64 returns float64 representation of the named option.
+//
+// Returns an error if a section does not exist.
+// Returns an error if the option does not exist either in the section or in
+// the defaults.
 func (p *ConfigParser) GetFloat64(section, option string) (float64, error) {
 	result, err := p.get(section, option)
 	if err != nil {
@@ -221,6 +231,11 @@ func (p *ConfigParser) GetFloat64(section, option string) (float64, error) {
 	return value.(float64), nil
 }
 
+// GetBool returns bool representation of the named option.
+//
+// Returns an error if a section does not exist.
+// Returns an error if the option does not exist either in the section or in
+// the defaults.
 func (p *ConfigParser) GetBool(section, option string) (bool, error) {
 	result, err := p.get(section, option)
 	if err != nil {
@@ -245,6 +260,7 @@ func (p *ConfigParser) GetBool(section, option string) (bool, error) {
 	return value.(bool), nil
 }
 
+// RemoveSection removes given section from the ConfigParser.
 func (p *ConfigParser) RemoveSection(section string) error {
 	if !p.HasSection(section) {
 		return getNoSectionError(section)
@@ -254,6 +270,7 @@ func (p *ConfigParser) RemoveSection(section string) error {
 	return nil
 }
 
+// HasOption checks if section contains option.
 func (p *ConfigParser) HasOption(section, option string) (bool, error) {
 	var s *Section
 	if p.isDefaultSection(section) {
@@ -268,6 +285,7 @@ func (p *ConfigParser) HasOption(section, option string) (bool, error) {
 	return err == nil, nil
 }
 
+// RemoveOption removes option from the section.
 func (p *ConfigParser) RemoveOption(section, option string) error {
 	var s *Section
 	if p.isDefaultSection(section) {

section.go

@@ -2,12 +2,14 @@ package configparser
 
 import "strings"
 
+// Section represent each section of the configuration file.
 type Section struct {
 	Name    string
 	options Dict
 	lookup  Dict
 }
 
+// Add adds new key-value pair to the section.
 func (s *Section) Add(key, value string) error {
 	lookupKey := s.safeKey(key)
 	s.options[key] = s.safeValue(value)
@@ -16,6 +18,10 @@ func (s *Section) Add(key, value string) error {
 	return nil
 }
 
+// Get returns value of an option with the given key.
+//
+// Returns an error if the option does not exist either in the section or in
+// the defaults.
 func (s *Section) Get(key string) (string, error) {
 	lookupKey, present := s.lookup[s.safeKey(key)]
 	if !present {
@@ -28,10 +34,12 @@ func (s *Section) Get(key string) (string, error) {
 	return "", getNoOptionError(s.Name, key)
 }
 
+// Options returns a slice of option names.
 func (s *Section) Options() []string {
 	return s.options.Keys()
 }
 
+// Items returns a Dict with the key-value pairs.
 func (s *Section) Items() Dict {
 	return s.options
 }
@@ -44,6 +52,10 @@ func (s *Section) safeKey(in string) string {
 	return strings.ToLower(strings.TrimSpace(in))
 }
 
+// Remove removes option with the given name from the section.
+//
+// Returns an error if the option does not exist either in the section or in
+// the defaults.
 func (s *Section) Remove(key string) error {
 	_, present := s.options[key]
 	if !present {