Add some documentation

Author: olivere

indices_get_aliases.go

@@ -141,6 +141,7 @@ func (s *AliasesService) Do(ctx context.Context) (*AliasesResult, error) {
 
 // -- Result of an alias request.
 
+// AliasesResult is the outcome of calling AliasesService.Do.
 type AliasesResult struct {
 	Indices map[string]indexResult
 }
@@ -154,6 +155,7 @@ type aliasResult struct {
 	IsWriteIndex bool
 }
 
+// IndicesByAlias returns all indices given a specific alias name.
 func (ar AliasesResult) IndicesByAlias(aliasName string) []string {
 	var indices []string
 	for indexName, indexInfo := range ar.Indices {
@@ -166,6 +168,7 @@ func (ar AliasesResult) IndicesByAlias(aliasName string) []string {
 	return indices
 }
 
+// HasAlias returns true if the index has a specific alias.
 func (ir indexResult) HasAlias(aliasName string) bool {
 	for _, alias := range ir.Aliases {
 		if alias.AliasName == aliasName {

indices_get_aliases_test.go

@@ -79,7 +79,7 @@ func TestAliasesBuildURL(t *testing.T) {
 func TestAliases(t *testing.T) {
 	var err error
 
-	//client := setupTestClientAndCreateIndex(t, SetTraceLog(log.New(os.Stdout, "", 0)))
+	// client := setupTestClientAndCreateIndex(t, SetTraceLog(log.New(os.Stdout, "", 0)))
 	client := setupTestClientAndCreateIndex(t)
 
 	// Some tweets