Skip to content
This repository was archived by the owner on Jun 25, 2020. It is now read-only.

GoDoc fixes to re-enable the linter golint #246

Merged
merged 4 commits into from
Jan 28, 2019
Merged

GoDoc fixes to re-enable the linter golint #246

merged 4 commits into from
Jan 28, 2019

Conversation

mattysweeps
Copy link
Contributor

@mattysweeps mattysweeps commented Jan 28, 2019

The purpose of this PR is to re-enable the golint linter as part of the CI process.
The reason it has been disabled is missing GoDoc.

This PR fixes GoDoc for:

  • example app
  • spinner
  • nozzle

The src/stackdriver-nozzle/mocks packaged is excluded from linting for now. An Issue has been opened to explore better solutions: #245

In some cases, variables which didn't need to be exported are no longer exported.

I also removed the example app's /info endpoint. I do not think it was being used by any health checks.

Some exported types were unexported for better encapsulation.
* GoDoc additions
* Removed the info endpoint, as it did nothing. I do not believe any
health checks used this endpoint either.
Copy link

@josephlewis42 josephlewis42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Some of the legacy code in here doesn't look super idiomatic, but the docs look like an improvement.

@mattysweeps mattysweeps merged commit 6238212 into develop Jan 28, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants