Skip to content

Commit 805f0db

Browse files
authored
fix typos, remove alias from docs (#233)
1 parent 1154563 commit 805f0db

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

docs/checks/commands/check_pdh.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: pdh
44

55
## check_pdh
66

7-
Checks pdh paths and handles wildcard expansion. Also available with the alias CheckCounter
7+
Checks pdh paths and handles wildcard expansion.
88

99
- [Examples](#examples)
1010
- [Attributes](#attributes)
@@ -43,13 +43,13 @@ Naemon Config
4343

4444
| Argument | Description |
4545
| ------------ | -------------------------------------------------------------------------------------------------- |
46-
| Counter | The fully qualified counter Name |
47-
| counter | The fully qualified counter Name |
48-
| english | Using English Names Regardless of system Language requires Windows Vista or higher |
46+
| Counter | The fully qualified counter name |
47+
| counter | The fully qualified counter name |
48+
| english | Using english names regardless of system language (requires Windows Vista or higher) |
4949
| expand-index | Should indices be translated? |
50-
| host | The name Of the machine in the network where the nounter should be searched, defaults to localhost |
51-
| instances | Expand wildcards And fetch all instances |
52-
| type | this can be large or float depending what you expect, default is large |
50+
| host | The name of the machine in the network where the counter should be searched, defaults to localhost |
51+
| instances | Expand wildcards and fetch all instances |
52+
| type | This can be large or float depending on what you expect, default is large |
5353

5454
## Attributes
5555

pkg/snclient/check_pdh.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,20 @@ func (c *CheckPDH) Build() *CheckData {
2626
return &CheckData{
2727
implemented: Windows,
2828
name: "check_pdh",
29-
description: "Checks pdh paths and handles wildcard expansion. Also available with the alias CheckCounter",
29+
description: "Checks pdh paths and handles wildcard expansion.",
3030
detailSyntax: "%(name)",
3131
okSyntax: "%(status) - All %(count) counter values are ok",
3232
topSyntax: "%(status) - %(problem_count)/%(count) counter (%(count)) %(problem_list)",
3333
emptySyntax: "%(status) - No counter found",
3434
emptyState: CheckExitUnknown,
3535
args: map[string]CheckArgument{
36-
"counter": {value: &c.CounterPath, description: "The fully qualified counter Name"},
37-
"Counter": {value: &c.CounterPath, description: "The fully qualified counter Name"},
38-
"host": {value: &c.HostName, description: "The name Of the machine in the network where the nounter should be searched, defaults to localhost"},
36+
"counter": {value: &c.CounterPath, description: "The fully qualified counter name"},
37+
"Counter": {value: &c.CounterPath, description: "The fully qualified counter name"},
38+
"host": {value: &c.HostName, description: "The name of the machine in the network where the counter should be searched, defaults to localhost"},
3939
"expand-index": {value: &c.ExpandIndex, description: "Should indices be translated?"},
40-
"instances": {value: &c.Instances, description: "Expand wildcards And fetch all instances"},
41-
"type": {value: &c.Type, description: "this can be large or float depending what you expect, default is large "},
42-
"english": {value: &c.EnglishFallBackNames, description: "Using English Names Regardless of system Language requires Windows Vista or higher"},
40+
"instances": {value: &c.Instances, description: "Expand wildcards and fetch all instances"},
41+
"type": {value: &c.Type, description: "This can be large or float depending on what you expect, default is large "},
42+
"english": {value: &c.EnglishFallBackNames, description: "Using english names regardless of system language (requires Windows Vista or higher)"},
4343
},
4444
result: &CheckResult{
4545
State: CheckExitOK,

pkg/snclient/docs_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
func TestDocsExists(t *testing.T) {
1313
snc := StartTestAgent(t, "")
1414

15-
skipChecks := []string{"check_index", "check_nscp_version", "CheckCounter"}
15+
skipChecks := []string{"check_index", "check_nscp_version"}
1616

1717
assert.GreaterOrEqualf(t, len(AvailableChecks), 25, "there should be checks available")
1818

0 commit comments

Comments
 (0)