0 MindSpore文档写作规范
TingWang edited this page 1 year ago
文档类型 内容要求 格式要求
开发指南(含教程、编程指南等文档) - 每篇文档需要包括开发概述开发任务样例代码三部分。
- 所有文档需有完整可运行的代码,文档只允许以下两种方式:
1. Notebook(可一键运行)
2. Markdown+可一键运行的完整代码/代码工程
- Notebook
- Markdown
API描述 - API Checklist
- 中文API补充Checklist
- 中文
- 英文
样例代码(含开发指南和API) 典型、完整、可运行、易复现、没有WARNING/ERROR信息 - Python编程规范
- C++编程规范
- import推荐