Add required comments to heartbeat monitors #8316
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
houndci-bot
reviewed
Sep 14, 2018
heartbeat/monitors/pluginconf.go
Outdated
| return fmt.Sprintf("Monitor not loaded, plugin is disabled") | ||
| } | ||
| // PluginDisabledError is returned when the monitor plugin is marked as disabled. | ||
| var PluginDisabledError = errors.New("Monitor not loaded, plugin is disabled") |
There was a problem hiding this comment.
error var PluginDisabledError should have name of the form ErrFoo
heartbeat/monitors/monitor.go
Outdated
| @@ -228,6 +229,8 @@ func (m *Monitor) Start() { | |||
| } | |||
| } | |||
|
|
|||
| // Start stops the Monitor's execution in its configured scheduler. | |||
There was a problem hiding this comment.
comment on exported method Monitor.Stop should be of the form "Stop ..."
Some of these functions needed comments to keep inline with go style guides. I also simplified one error by using errors.New instead of a custom error struct.
andrewvc
force-pushed
the
hbreload-hound
branch
from
778c747
to
30e2987
Compare
exekias
approved these changes
Sep 17, 2018
andrewvc
added a commit
to andrewvc/beats
that referenced
this pull request
Sep 19, 2018
Some of these functions needed comments to keep inline with go style guides. I also simplified one error by using errors.New instead of a custom error struct. (cherry picked from commit 28977fb)
andrewvc
added a commit
that referenced
this pull request
Sep 27, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some of these functions needed comments to keep inline with go style guides. The change that introduced these was in #8023 .
I also simplified one error by using errors.New instead of a custom error struct.