doc(pkg): ensure that sentences are terminated by a '.'

Author: Aaron Schlesinger

pkg/builder.go

@@ -1,6 +1,7 @@
 // Package pkg provides common libraries for the Deis builder.
 //
-// The Deis builder is responsible for packaging Docker images for consumers.
+// The Deis builder is responsible for building slugs and docker images for use in the Deis
+// on the Deis PaaS platform.
 package pkg
 
 import (

pkg/cleaner/cleaner.go

@@ -1,5 +1,5 @@
 // Package cleaner is a background process that compares the kubernetes namespace list with the
-// folders in the local git home directory, deleting what's not in the namespace list
+// folders in the local git home directory, deleting what's not in the namespace list.
 package cleaner
 
 import (

pkg/controller/utils.go

@@ -62,7 +62,7 @@ func fingerprint(key ssh.PublicKey) string {
 	return string(fp)
 }
 
-// UserInfoFromKey makes a request to the controller to get the user info from they given key
+// UserInfoFromKey makes a request to the controller to get the user info from they given key.
 func UserInfoFromKey(key ssh.PublicKey) (*UserInfo, error) {
 	fp := fingerprint(key)
 	url, err := controllerURLStr("v2", "hooks", "key", fp)

pkg/git/git.go

@@ -25,7 +25,7 @@ import (
 // prereceiveHookTplStr is the template for a pre-receive hook. The following template variables
 // are passed into it:
 //
-// 	.GitHome: the path to Git's home directory.
+// - .GitHome: the path to Git's home directory
 const preReceiveHookTplStr = `#!/bin/bash
 strip_remote_prefix() {
     stdbuf -i0 -o0 -e0 sed "s/^/"$'\e[1G'"/"

pkg/gitreceive/config.go

@@ -11,7 +11,7 @@ const (
 )
 
 // Config is the envconfig (http://github.com/kelseyhightower/envconfig) compatible struct for the
-// builder's git-receive hook
+// builder's git-receive hook.
 type Config struct {
 	// k8s service discovery env vars
 	ControllerHost string `envconfig:"DEIS_CONTROLLER_SERVICE_HOST" required:"true"`
@@ -38,7 +38,7 @@ type Config struct {
 }
 
 // App returns the application name represented by c. The app name is the same as c.Repository
-// with the last '.' and beyond stripped off
+// with the last '.' and beyond stripped off.
 func (c Config) App() string {
 	li := strings.LastIndex(c.Repository, ".")
 	if li == -1 {
@@ -48,31 +48,31 @@ func (c Config) App() string {
 }
 
 // BuilderPodTickDuration returns the size of the interval used to check for
-// the end of the execution of a Pod building an application
+// the end of the execution of a Pod building an application.
 func (c Config) BuilderPodTickDuration() time.Duration {
 	return time.Duration(time.Duration(c.BuilderPodTickDurationMSec) * time.Millisecond)
 }
 
 // BuilderPodWaitDuration returns the maximum time to wait for the end
-// of the execution of a Pod building an application
+// of the execution of a Pod building an application.
 func (c Config) BuilderPodWaitDuration() time.Duration {
 	return time.Duration(time.Duration(c.BuilderPodWaitDurationMSec) * time.Millisecond)
 }
 
 // ObjectStorageTickDuration returns the size of the interval used to check for
-// the end of an operation that involves the object storage
+// the end of an operation that involves the object storage.
 func (c Config) ObjectStorageTickDuration() time.Duration {
 	return time.Duration(time.Duration(c.ObjectStorageTickDurationMSec) * time.Millisecond)
 }
 
 // ObjectStorageWaitDuration returns the maximum time to wait for the end of an
-// operation that involves the object storage
+// operation that involves the object storage.
 func (c Config) ObjectStorageWaitDuration() time.Duration {
 	return time.Duration(time.Duration(c.ObjectStorageWaitDurationMSec) * time.Millisecond)
 }
 
 // CheckDurations checks if ticks for builder and object storage are not bigger
-// than the maximum duration. In case of this it will set the tick to the default
+// than the maximum duration. In case of this it will set the tick to the default.
 func (c *Config) CheckDurations() {
 	if c.BuilderPodTickDurationMSec >= c.BuilderPodWaitDurationMSec {
 		c.BuilderPodTickDurationMSec = builderPodTick

pkg/gitreceive/git/sha.go

@@ -12,12 +12,12 @@ const (
 
 var shaRegex = regexp.MustCompile(`^[\da-f]{40}$`)
 
-// ErrInvalidGitSha is returned by NewSha if the given raw sha is invalid for any reason
+// ErrInvalidGitSha is returned by NewSha if the given raw sha is invalid for any reason.
 type ErrInvalidGitSha struct {
 	sha string
 }
 
-// Error is the error interface implementation
+// Error is the error interface implementation.
 func (e ErrInvalidGitSha) Error() string {
 	return fmt.Sprintf("git sha %s was invalid", e.sha)
 }
@@ -28,16 +28,16 @@ type SHA struct {
 	short string
 }
 
-// NewSha creates a raw string to a SHA. Returns ErrInvalidGitSha if the sha was invalid
+// NewSha creates a raw string to a SHA. Returns ErrInvalidGitSha if the sha was invalid.
 func NewSha(rawSha string) (*SHA, error) {
 	if !shaRegex.MatchString(rawSha) {
 		return nil, ErrInvalidGitSha{sha: rawSha}
 	}
 	return &SHA{full: rawSha, short: rawSha[0:8]}, nil
 }
 
-// Full returns the full git sha
+// Full returns the full git sha.
 func (s SHA) Full() string { return s.full }
 
-// Short returns the first 8 characters of the sha
+// Short returns the first 8 characters of the sha.
 func (s SHA) Short() string { return s.short }

pkg/gitreceive/run.go

@@ -23,7 +23,8 @@ func readLine(line string) (string, string, string, error) {
 	return spl[0], spl[1], spl[2], nil
 }
 
-// Run runs the git-receive hook
+// Run runs the git-receive hook. This func is effectively the main for the git-receive hook,
+// although it is called from the main in boot.go.
 func Run(conf *Config, fs sys.FS, env sys.Env) error {
 	log.Debug("Running git hook")
 

pkg/gitreceive/storage/auth.go

@@ -31,7 +31,7 @@ func (c *creds) isZero() bool {
 // getAuth gets storage credentials from accessKeyIDFile and accessSecretKeyFile.
 // if a key exists but not a secret, or vice-versa, returns an error.
 // if both don't exist returns emptyAuth.
-// otherwise returns a valid auth
+// otherwise returns a valid auth.
 func getAuth(fs sys.FS) (*creds, error) {
 	accessKeyIDBytes, accessKeyErr := fs.ReadFile(accessKeyIDFile)
 	accessSecretKeyBytes, accessSecretKeyErr := fs.ReadFile(accessSecretKeyFile)
@@ -50,7 +50,7 @@ func getAuth(fs sys.FS) (*creds, error) {
 	return &creds{accessKeyID: id, accessKeySecret: secret}, nil
 }
 
-// CredsOK checks if the required credentials to make a request exist
+// CredsOK checks if the required credentials to make a request exist.
 func CredsOK(fs sys.FS) bool {
 	creds, err := getAuth(fs)
 	if err != nil {

pkg/gitreceive/storage/bucket.go

@@ -10,12 +10,12 @@ const (
 )
 
 var (
-	// ACLPublicRead default ACL for objects in the S3 API compatible storage
+	// ACLPublicRead default ACL for objects in the S3 API compatible storage.
 	ACLPublicRead = s3.BucketACL("public-read")
 )
 
-// CreateBucket creates a new bucket in the S3 API compatible storage or
-// return an error in case the bucket already exists
+// CreateBucket creates a new bucket in the S3 API compatible storage. If the bucket was
+// successfully created or already exists, returns nil. Otherwise returns an appropriate error.
 func CreateBucket(creator BucketCreator, bucketName string) error {
 	if err := creator.MakeBucket(bucketName, ACLPublicRead, ""); err != nil {
 		minioErr := s3.ToErrorResponse(err)

pkg/gitreceive/storage/client.go

@@ -5,14 +5,14 @@ import (
 	s3 "github.com/minio/minio-go"
 )
 
-// Client is the S3 client combined with the S3 endpoint
+// Client is the S3 client combined with the S3 endpoint.
 type Client struct {
 	*s3.Client
-	// Endpoint is the the endpoint information for the location that the S3 client will access
+	// Endpoint is the the endpoint information for the location that the S3 client will access.
 	Endpoint *Endpoint
 }
 
-// GetClient returns a S3 API compatible storage client
+// GetClient returns a S3 API compatible storage client.
 func GetClient(regionStr string, fs sys.FS, env sys.Env) (*Client, error) {
 	auth, err := getAuth(fs)
 	if err != nil {
@@ -25,7 +25,7 @@ func GetClient(regionStr string, fs sys.FS, env sys.Env) (*Client, error) {
 	}
 
 	// the New function call guesses which signature version to use. Currently, it correctly guesses
-	// V2 for GCS and V4 for both AWS S3 and Minio
+	// V2 for GCS and V4 for both AWS S3 and Minio.
 	s3Client, err := s3.New(endpoint.URLStr, auth.accessKeyID, auth.accessKeySecret, !endpoint.Secure)
 	if err != nil {
 		return nil, err