提交 ec619dc1 编写于 作者: M mindspore-ci-bot 提交者: Gitee

!604 Add description about table format.

Merge pull request !604 from zhangyi/mod_contri
......@@ -79,7 +79,7 @@ The procedure for submitting the modification is the same as that for submitting
```
- A blank line must be added before and after an image and an image title. Otherwise, the typesetting will be abnormal.
- A blank line must be added before and after an image and an image title. Otherwise, the typesetting will be abnormal. For example as correctly:
```
Example:
......@@ -91,6 +91,19 @@ The procedure for submitting the modification is the same as that for submitting
The following content.
```
- A blank line must be added before and after a table. Otherwise, the typesetting will be abnormal. Tables are not supported in ordered or unordered lists. For example as correctly:
```
## Title
| Header1 | Header2
| :----- | :----
| Body I1 | Body I2
| Body II1 | Body II2
The following content.
```
- Mark the reference interface, path name, file name in the tutorial and document with "\` \`". If it's a function or method, don't use parentheses at the end. For example:
- Reference method
......
......@@ -79,7 +79,7 @@
```
- 图和图标题前后需增加一个空行,否则会导致排版异常。
- 图和图标题前后需增加一个空行,否则会导致排版异常。正确举例如下:
```
如下图所示:
......@@ -91,6 +91,19 @@
下文内容。
```
- 表格前后需增加一个空行,否则会导致排版异常。有序或无序列表内不支持表格。正确举例如下:
```
## 文章标题
| 表头1 | 表头2
| :----- | :----
| 内容I1 | 内容I2
| 内容II1 | 内容II2
下文内容。
```
- 教程、文档中引用接口、路径名、文件名等使用“\` \`”标注,如果是函数或方法,最后不加括号。举例如下:
- 引用方法
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册