Fix docs and comments (#51)

- Typo fixes
- Formatting fixes
- Various small inaccuracies
- Code comments fixes

Author: infraredgirl

README.md

@@ -25,9 +25,9 @@ type githubRepositoriesService interface {
 
 // GithubClient is the data structure that is common between production code and test code. In production code,
 // go-github satisfies the PullRequests and Repositories service interfaces, whereas in test the concrete
-// implementations for these same services are mocks that return a static slice of pointers to github repositories,
-// or a single pointer to a github repository, as appropriate. This allows us to test the workflow of git-xargs
-// without actually making API calls to Github when running tests
+// implementations for these same services are mocks that return a static slice of pointers to GitHub repositories,
+// or a single pointer to a GitHub repository, as appropriate. This allows us to test the workflow of git-xargs
+// without actually making API calls to GitHub when running tests
 type GithubClient struct {
 	PullRequests githubPullRequestService
 	Repositories githubRepositoriesService
@@ -40,7 +40,7 @@ func NewClient(client *github.Client) GithubClient {
 	}
 }
 
-// configureGithubClient creates a Github API client using the user-supplied GITHUB_OAUTH_TOKEN and return the configured Github client
+// ConfigureGithubClient creates a GitHub API client using the user-supplied GITHUB_OAUTH_TOKEN and returns the configured GitHub client
 func ConfigureGithubClient() GithubClient {
 	// Ensure user provided a GITHUB_OAUTH_TOKEN
 	GithubOauthToken := os.Getenv("GITHUB_OAUTH_TOKEN")
@@ -57,7 +57,7 @@ func ConfigureGithubClient() GithubClient {
 	return client
 }
 
-// ensureGithubOauthTokenSet is a sanity check that a value is exported for GITHUB_OAUTH_TOKEN
+// EnsureGithubOauthTokenSet is a sanity check that a value is exported for GITHUB_OAUTH_TOKEN
 func EnsureGithubOauthTokenSet() error {
 	if os.Getenv("GITHUB_OAUTH_TOKEN") == "" {
 		return errors.WithStackTrace(types.NoGithubOauthTokenProvidedErr{})

auth/auth.go

@@ -7,7 +7,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-// TestConfigureGithubClient performs a sanity check that you can configure a production Github API client
+// TestConfigureGithubClient performs a sanity check that you can configure a production GitHub API client
 func TestConfigureGithubClient(t *testing.T) {
 	t.Parallel()
 
@@ -16,7 +16,7 @@ func TestConfigureGithubClient(t *testing.T) {
 }
 
 // TestNoGithubOauthTokenPassed temporarily drops the existing GITHUB_OAUTH_TOKEN env var to ensure that the validation
-// code throws an error when it is mising. It then replaces it. This is therefore the one test that cannot be run in
+// code throws an error when it is missing. It then replaces it. This is therefore the one test that cannot be run in
 // parallel.
 func TestNoGithubOAuthTokenPassed(t *testing.T) {
 	token := os.Getenv("GITHUB_OAUTH_TOKEN")

auth/auth_test.go

@@ -88,7 +88,7 @@ func parseSliceFromReader(reader io.Reader) ([]string, error) {
 // handleRepoProcessing encapsulates the main processing logic for the supplied repos and printing the run report that
 // is built up throughout the processing
 func handleRepoProcessing(config *config.GitXargsConfig) error {
-	// Track whether or not pull requests were skipped
+	// Track whether pull requests were skipped
 	config.Stats.SetSkipPullRequests(config.SkipPullRequests)
 
 	// Update raw command supplied
@@ -124,7 +124,7 @@ func sanityCheckInputs(config *config.GitXargsConfig) error {
 	return nil
 }
 
-// runGitXargs is the urfave cli app's Action that is called when the user executes the binary
+// RunGitXargs is the urfave cli app's Action that is called when the user executes the binary
 func RunGitXargs(c *cli.Context) error {
 	// If someone calls us with no args at all, show the help text and exit
 	if !c.Args().Present() {

cmd/git-xargs.go

@@ -30,7 +30,7 @@ type GitXargsConfig struct {
 	Stats                  *stats.RunStats
 }
 
-// NewGitXargsConfig sets reasonable defaults for a GitXargsConfig and returns a pointer to a the config
+// NewGitXargsConfig sets reasonable defaults for a GitXargsConfig and returns a pointer to the config
 func NewGitXargsConfig() *GitXargsConfig {
 	return &GitXargsConfig{
 		DryRun:                 false,

config/config.go

@@ -11,9 +11,9 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-// This utility function accepts a path to the flatfile in which the user has defined their explicitly allowed repos
-// It expects repos to be defined one per line in the following format: `gruntwork-io/cloud-nuke` with optional commas
-// Stray single and double quotes are also handled and stripped out if they are encountered, and spacing is irrelevant
+// ProcessAllowedRepos accepts a path to the flat file in which the user has defined their explicitly allowed repos.
+// It expects repos to be defined one per line in the following format: `gruntwork-io/cloud-nuke` with optional commas.
+// Stray single and double quotes are also handled and stripped out if they are encountered, and spacing is irrelevant.
 func ProcessAllowedRepos(filepath string) ([]*types.AllowedRepo, error) {
 	logger := logging.GetLogger("git-xargs")
 

io/io.go

@@ -25,7 +25,7 @@ func TestProcessAllowedReposCorrectlyParsesValidReposFile(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, len(allowedRepos), 3)
 
-	// Test that repo names are correctly parsed from the flat file by initiallly setting a map of each repo name
+	// Test that repo names are correctly parsed from the flat file by initially setting a map of each repo name
 	// to false, and then updating each entry to true as we find them in the flat file. At the end, all map entries should be true / seen
 	mapOfExpectedRepoNames := make(map[string]bool)
 	mapOfExpectedRepoNames["fetch"] = false
@@ -56,7 +56,7 @@ func TestProcessAllowedReposCorrectlyFiltersMalformedInput(t *testing.T) {
 	// be returned by the function as valid repos to operate on
 	assert.Equal(t, len(allowedRepos), 3)
 
-	// Test that repo names are correctly parsed from the flat file by initiallly setting a map of each repo name
+	// Test that repo names are correctly parsed from the flat file by initially setting a map of each repo name
 	// to false, and then updating each entry to true as we find them in the flat file. At the end, all map entries should be true / seen
 	mapOfExpectedRepoNames := make(map[string]bool)
 	mapOfExpectedRepoNames["fetch"] = false

io/io_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/gruntwork-io/go-commons/errors"
 )
 
-// Sanity check that user has provided one valid method for selecting repos to operate on
+// EnsureValidOptionsPassed checks that user has provided one valid method for selecting repos to operate on
 func EnsureValidOptionsPassed(config *config.GitXargsConfig) error {
 	if len(config.RepoSlice) < 1 && config.ReposFile == "" && config.GithubOrg == "" && len(config.RepoFromStdIn) == 0 {
 		return errors.WithStackTrace(types.NoRepoSelectionsMadeErr{})

io/validate-input.go

@@ -10,7 +10,7 @@ import (
 	"github.com/urfave/cli"
 )
 
-// This variable is set at build time using -ldflags parameters. For example, we typically set this flag in circle.yml
+// VERSION is set at build time using -ldflags parameters. For example, we typically set this flag in circle.yml
 // to the latest Git tag when building our Go apps:
 //
 // build-go-binaries --app-name my-app --dest-path bin --ld-flags "-X main.VERSION=$CIRCLE_TAG"
@@ -42,7 +42,7 @@ func setupApp() *cli.App {
 	app := entrypoint.NewApp()
 	entrypoint.HelpTextLineWidth = 120
 
-	// Override the CLI FlagEnvHinter so it only returns the Usage text of the Flag and doesn't apend the envVar text. Original func https://github.com/urfave/cli/blob/master/flag.go#L652
+	// Override the CLI FlagEnvHinter, so it only returns the Usage text of the Flag and doesn't append the envVar text. Original func https://github.com/urfave/cli/blob/master/flag.go#L652
 	cli.FlagEnvHinter = func(envVar, str string) string {
 		return str
 	}