This is an automated email from the ASF dual-hosted git repository.
shenghang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push:
new 9024b2aca [improve] improve markdown format for MD033 (#2657)
9024b2aca is described below
commit 9024b2aca2ca860da31785fd8aa31e3757dce161
Author: Calvin <[email protected]>
AuthorDate: Tue Sep 3 22:06:50 2024 +0800
[improve] improve markdown format for MD033 (#2657)
Co-authored-by: aias00 <[email protected]>
Co-authored-by: Jast <[email protected]>
---
.markdownlint-cli2.jsonc | 4 +++-
home/docs/community/code-style-and-quality-guide.md | 2 +-
.../current/community/code-style-and-quality-guide.md | 2 +-
.../version-v1.5.x/community/code-style-and-quality-guide.md | 2 +-
.../version-v1.5.x/community/code-style-and-quality-guide.md | 2 +-
5 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
index 75dc779b7..03ba976d8 100644
--- a/.markdownlint-cli2.jsonc
+++ b/.markdownlint-cli2.jsonc
@@ -29,7 +29,9 @@
},
"MD025": true,
"MD029": true,
- "MD033": false,
+ "MD033": {
+ "allowed_elements": ["table", "tr", "td", "a", "img", "sub", "b", "br",
"img", "tbody", "mark", "font"]
+ },
"MD036": false,
"MD040": true,
"MD045": false,
diff --git a/home/docs/community/code-style-and-quality-guide.md
b/home/docs/community/code-style-and-quality-guide.md
index e0ec5231c..32b85edf1 100644
--- a/home/docs/community/code-style-and-quality-guide.md
+++ b/home/docs/community/code-style-and-quality-guide.md
@@ -229,7 +229,7 @@ Error code description:
For example, if the parameter cannot be null, it is best to add a
`@Nonnull` annotation. If the returned value can be null, the `@Nullable`
annotation should be added first.
- <mark> Note: that the package name is <code>javax.validation.requirements
</code> </mark>
+ <mark> Note: that the package name is <b>javax.validation.requirements</b>
</mark>
3. If there are too many lines of code in the method, please have a try on
using multiple sub methods at appropriate points to segment the method body.
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md
index ca23f3db7..52c581a1f 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md
@@ -231,7 +231,7 @@ limitations under the License.
例如，如果参数不能为 null，最好添加一个 `@Nonnull` 注释。如果返回值可以为 null，则应首先添加 `@Nullable` 注释。
- <mark> 注意：包名为 <code>javax.validation.requirements </code> </mark>
+ <mark> 注意：包名为 <b>javax.validation.requirements</b> </mark>
3. 如果方法中的代码行数太多，请尝试在适当的点上使用多个子方法来分段方法体。
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md
index dea85bc8a..2e328a31e 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md
@@ -168,7 +168,7 @@ limitations under the License.
例如，如果参数不能为 null，最好添加一个 `@Nonnull` 注释。如果返回值可以为 null，则应首先添加 `@Nullable` 注释。
- <mark> 注意：包名为 <code>javax.validation.requirements </code> </mark>
+ <mark> 注意：包名为 <b>javax.validation.requirements</b> </mark>
3. 如果方法中的代码行数太多，请尝试在适当的点上使用多个子方法来分段方法体。
diff --git
a/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md
b/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md
index ef27d0d5f..afde10c45 100644
---
a/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md
+++
b/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md
@@ -168,7 +168,7 @@ limitations under the License.
For example, if the parameter cannot be null, it is best to add a
`@Nonnull` annotation. If the returned value can be null, the `@Nullable`
annotation should be added first.
- <mark> Note: that the package name is <code>javax.validation.requirements
</code> </mark>
+ <mark> Note: that the package name is <b>javax.validation.requirements</b>
</mark>
3. If there are too many lines of code in the method, please have a try on
using multiple sub methods at appropriate points to segment the method body.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
