diff --git a/CONTRIBUTING_DOC.md b/CONTRIBUTING_DOC.md index 9453ed63d158f21db9acbcda591a6b61f107e77e..717d852c89c21330fde40cbc58664e29a8053064 100644 --- a/CONTRIBUTING_DOC.md +++ b/CONTRIBUTING_DOC.md @@ -90,3 +90,43 @@ The procedure for submitting the modification is the same as that for submitting 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 + + ``` + Use the `map` method. + ``` + + - Reference code + + ``` + `batch_size`: number of data in each group. + ``` + + - Reference path + + ``` + Decompress the dataset and store it in `./MNIST_Data`. + ``` + + - Reference file name + + ``` + Other dependencies is described in `requirements.txt`. + ``` + +- In tutorials and documents, the contents that need to be replaced need additional annotation. In the body, a "*" should be added before and after the content. In the code snippet, the content should be annotated with "{}". For example: + + - In body + + ``` + Need to replace your local path *your_ path*. + ``` + + - In code snippet + + ``` + conda activate {your_env_name} + ``` \ No newline at end of file diff --git a/CONTRIBUTING_DOC_CN.md b/CONTRIBUTING_DOC_CN.md index 914ba5b6e5820fe8fd1441df90507ca55fd3d1c2..173e1b681ad82ac03830322e6fd5e2e47c81d719 100644 --- a/CONTRIBUTING_DOC_CN.md +++ b/CONTRIBUTING_DOC_CN.md @@ -89,4 +89,44 @@ 图1:xxx 下文内容。 - ``` \ No newline at end of file + ``` + +- 教程、文档中引用接口、路径名、文件名等使用“\` \`”标注,如果是函数或方法,最后不加括号。举例如下: + + - 引用方法 + + ``` + 使用映射 `map` 方法。 + ``` + + - 引用代码 + + ``` + `batch_size`:每组包含的数据个数。 + ``` + + - 引用路径 + + ``` + 将数据集解压存放到工作区`./MNIST_Data`路径下。 + ``` + + - 引用文件名 + + ``` + 其他依赖项在`requirements.txt`中有详细描述。 + ``` + +- 教程、文档中待用户替换的内容需要额外标注,在正文中,使用“*”包围需要替换内容,在代码片段中,使用“{}”包围替换内容。举例如下: + + - 正文中 + + ``` + 需要替换你的本地路径*your_path*。 + ``` + + - 代码片段中 + + ``` + conda activate {your_env_name} + ```