Skip to content

Commit

Permalink
[improve] fix PlcCollectImpl check markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
ZY945 committed Dec 1, 2024
1 parent 0b00d16 commit 46e7930
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 27 deletions.
39 changes: 25 additions & 14 deletions home/docs/help/modbus.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,20 @@ keywords: [ open source monitoring tool, Modbus monitoring ]

Parameter example:

Coil register addresses:
- 1,2[3]
Coil register addresses:
```text

Check failure on line 32 in home/docs/help/modbus.md

View workflow job for this annotation

GitHub Actions / docs-build

Fenced code blocks should be surrounded by blank lines

home/docs/help/modbus.md:32 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```text"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
1,2[3]
```

Parameter alias names:

- holding-register:0
- holding-register:1-0
- holding-register:1-1
- holding-register:1-2
```yaml

Check failure on line 37 in home/docs/help/modbus.md

View workflow job for this annotation

GitHub Actions / docs-build

Fenced code blocks should be surrounded by blank lines

home/docs/help/modbus.md:37 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```yaml"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
aliasFields:
- responseTime
- holding-register:0
- holding-register:1-0
- holding-register:1-1
- holding-register:1-2
```
| Metric Name | Metric Unit | Metric Help Description |
|----------------------------|--------------|-----------------------------------------------------------------|
Expand All @@ -48,16 +53,22 @@ Parameter alias names:
1. The number of parameters must match the total number of coil register addresses specified in the parameters.
2. Alias format for parameters: coil:m or coil:m-n
Parameter example:
Parameter example:
Coil register addresses:
- 1,2[3]
Coil register addresses:
```text

Check failure on line 59 in home/docs/help/modbus.md

View workflow job for this annotation

GitHub Actions / docs-build

Fenced code blocks should be surrounded by blank lines

home/docs/help/modbus.md:59 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```text"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
1,2[3]
```

Check failure on line 61 in home/docs/help/modbus.md

View workflow job for this annotation

GitHub Actions / docs-build

Trailing spaces

home/docs/help/modbus.md:61:4 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md

Parameter alias names:
- coil:0
- coil:1-0
- coil:1-1
- coil:1-2
```yaml

Check failure on line 64 in home/docs/help/modbus.md

View workflow job for this annotation

GitHub Actions / docs-build

Fenced code blocks should be surrounded by blank lines

home/docs/help/modbus.md:64 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```yaml"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
aliasFields:
- responseTime
- coil:0
- coil:1-0
- coil:1-1
- coil:1-2
```
| Metric Name | Metric Unit | Metric Help Description |
|---------------|--------------|-----------------------------------------------------------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,19 @@ keywords: [ open source monitoring tool, Modbus监控 ]
参数示例:

线圈寄存器地址:
- 1,2[3]
```text

Check failure on line 32 in home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/modbus.md

View workflow job for this annotation

GitHub Actions / docs-build

Fenced code blocks should be surrounded by blank lines

home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/modbus.md:32 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```text"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
1,2[3]
```

参数别名名称:

- holding-register:0
- holding-register:1-0
- holding-register:1-1
- holding-register:1-2
```yaml

Check failure on line 37 in home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/modbus.md

View workflow job for this annotation

GitHub Actions / docs-build

Fenced code blocks should be surrounded by blank lines

home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/modbus.md:37 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```yaml"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
aliasFields:
- responseTime
- holding-register:0
- holding-register:1-0
- holding-register:1-1
- holding-register:1-2
```
| 指标名称 | 指标单位 | 指标帮助描述 |
|---------|------|---------------------|
Expand All @@ -51,17 +56,21 @@ keywords: [ open source monitoring tool, Modbus监控 ]
参数示例:
线圈寄存器地址:
- 1,2[3]
```text

Check failure on line 59 in home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/modbus.md

View workflow job for this annotation

GitHub Actions / docs-build

Fenced code blocks should be surrounded by blank lines

home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/modbus.md:59 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```text"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
1,2[3]
```

参数别名名称:

- coil:0
- coil:1-0
- coil:1-1
- coil:1-2
```yaml

Check failure on line 64 in home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/modbus.md

View workflow job for this annotation

GitHub Actions / docs-build

Fenced code blocks should be surrounded by blank lines

home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/modbus.md:64 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```yaml"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
aliasFields:
- responseTime
- coil:0
- coil:1-0
- coil:1-1
- coil:1-2
```
| 指标名称 | 指标单位 | 指标帮助描述 |
|------|------|---------------------|
| 响应时间 | 毫秒 | Modbus服务器响应请求所需的时间。 |
| 线圈状态 | | 线圈状态 (0或1) |

0 comments on commit 46e7930

Please sign in to comment.