doc changes

aws/s3/util.go

@@ -13,7 +13,7 @@ var (
 	log, _ = util.InitLoggerWithLevel(nil)
 )
 
-//Downloads a file from an S3 event's S3 Event Record. Takes in a pointer to a downloader object.
+//DownloadFileFromS3EventRecord downloads a file from an S3 event's S3 Event Record. Takes in a pointer to a downloader object.
 //		for _, eventObject := range event.Records {
 //		file, err := s3.DownloadFileFromS3EventRecord(downloader, eventObject)
 //		if err != nil {

aws/secretsmanager/util.go

@@ -11,7 +11,7 @@ var (
 	log, _ = util.InitLoggerWithLevel(nil)
 )
 
-//Retrieve a secret from Secrets Manager. Searches for a secret stored under the input
+//GetSecret retrieves a secret from Secrets Manager. Searches for a secret stored under the input
 //	secretId
 func GetSecret(secretId string) string {
 	sess, err := session.NewSession(&aws.Config{
@@ -28,7 +28,7 @@ func GetSecret(secretId string) string {
 	return *output.SecretString
 }
 
-//Create a Secrets Manager secret using a given CreateSecretInput. Return errors, if any.
+//CreateSecret creates a Secrets Manager secret using a given CreateSecretInput. Return errors, if any.
 func CreateSecret(opts secretsmanager.CreateSecretInput) error {
 	sess, err := session.NewSession(&aws.Config{
 		Region: aws.String(util.GetEnvOrDefault("AWS_REGION", "us-east-1")),
@@ -43,6 +43,3 @@ func CreateSecret(opts secretsmanager.CreateSecretInput) error {
 	}
 	return err
 }
-
-
-

db/redis/doc.go

@@ -1,2 +1,2 @@
-//Generic Utilities for dealing with Redis Clusters. Directly compatible with AWS ElastiCache.
+//Package redis contains generic utilities for dealing with Redis Clusters. Directly compatible with AWS ElastiCache.
 package redis

db/redis/handler.go

@@ -9,7 +9,7 @@ var (
 	log, _ = util.InitLoggerWithLevel(nil)
 )
 
-//Creates a pointer to a redis cluster client. By default looks for a redis cluster at
+//ClusterClient creates a pointer to a redis cluster client. By default looks for a redis cluster at
 //localhost on port 7000. Address can be configured with the REDIS_HOST environment
 //variable. An example for elasticache:
 //	somecluster.amazonaws.com:6379
@@ -29,7 +29,7 @@ func ClusterClient() *redis.ClusterClient {
 	return clusterClient
 }
 
-//Creates a pointer to a redis cluster client. Supports passing a pointer to a redis.Options struct with
+//ClusterClientWithOpts creates a pointer to a redis cluster client. Supports passing a pointer to a redis.Options struct with
 ////configurable parameters. An example for elasticache:
 //	somecluster.amazonaws.com:6379
 func ClusterClientWithOpts(options *redis.ClusterOptions) *redis.ClusterClient {
@@ -43,7 +43,7 @@ func ClusterClientWithOpts(options *redis.ClusterOptions) *redis.ClusterClient {
 	return clusterClient
 }
 
-//Creates a pointer to a redis client. By default looks for a redis server at
+//StandardClient creates a pointer to a redis client. By default looks for a redis server at
 //localhost on port 6379. Address can be configured with the REDIS_HOST environment
 //variable. An example for elasticache:
 //	someserver.amazonaws.com:6379
@@ -59,7 +59,7 @@ func StandardClient() *redis.Client {
 	return client
 }
 
-//Creates a pointer to a redis client. Supports passing a pointer to a redis.Options struct with
+//StandardClientWithOpts creates a pointer to a redis client. Supports passing a pointer to a redis.Options struct with
 //configurable parameters. An example for elasticache:
 //	someserver.amazonaws.com:6379
 func StandardClientWithOpts(options *redis.Options) *redis.Client {

db/sql/postgres/doc.go

@@ -1,2 +1,2 @@
-//Generic Utilities for dealing with Postgres Databases. Directly compatible with AWS RDS.
+//Package postgres contains generic utilities for dealing with Postgres Databases. Directly compatible with AWS RDS.
 package postgres