wyl/hertzbeat
1
0
Fork 0
mirror of https://github.com/dromara/hertzbeat.git synced 2026-09-17 09:40:58 +00:00
Code Issues Projects Releases Wiki Activity

[improve] improve markdown format for MD033 (#2657)

Browse Source 
Co-authored-by: aias00 <rokkki@163.com>
Co-authored-by: Jast <shenghang@apache.org>
This commit is contained in:
Calvin
2024-09-03 22:06:50 +08:00
committed by GitHub
co-authored by aias00 Jast
parent 5cd9590907
commit 9024b2aca2
5 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.markdownlint-cli2.jsonc
+3 -1
View File
@@ -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,
home/docs/community/code-style-and-quality-guide.md
+1 -1
View File
@@ -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.
home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md
+1 -1
View File
@@ -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. 如果方法中的代码行数太多，请尝试在适当的点上使用多个子方法来分段方法体。
home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md
+1 -1
View File
@@ -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. 如果方法中的代码行数太多，请尝试在适当的点上使用多个子方法来分段方法体。
home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md
+1 -1
View File
@@ -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.