已合并
fix: Modify the AIDD docs issue #1195
zwj223创建于 28 天前
fix: Modify the AIDD docs issue #1195
已合并
Pull Request已成功合入, 合并人@CANN-robot
(感谢 zwj223 的贡献)atomgit-bot
28 天前 评论:
28 天前 评论:
变更摘要
此 PR 主要针对 AIDD(AI 驱动开发)扫描中发现的核心文档问题进行修正,涉及 19 个文档文件,修改内容包括文档描述准确性、格式规范化以及相关信息的更新。所有改动均为文档层面的修正,增删行数持平(+67/-67),属于轻量级文档维护。
主要改动
- 多份算子及接口文档内容修正:对
op_list.md、QUICKSTART.md、broadcast关系.md、两段式接口.md、aclnn返回码.md等核心文档中的描述错误或过时信息进行统一更正 - 文档格式与规范性调整:对 19 个文档文件进行一致性修正,确保文档格式、术语表达与项目现行规范对齐
- 关联问题单闭环:本次文档修正关联 Issue #651,解决 AIDD 扫描中识别出的文档问题


atomgit-bot
28 天前 评论:
28 天前 评论:
代码审查
审查总结
审查了全部 19 个变更文件,共发现 2 个问题:
| 优先级 | 数量 |
|---|---|
| P1 | 1 |
| P3 | 1 |
各文件审查结果
| 文件 | 结果 |
|---|---|
CHANGELOG.md |
无问题 — 版本号格式修正 8.5.0-beta 1 → 8.5.0-beta.1,正确 |
docs/CONTRIBUTING_DOCS.md |
无问题 — 代码块语言标记修正、M→MB 单位修正 |
docs/QUICKSTART.md |
无问题 — 文本润色、代码块语言标记标准化 |
docs/zh/context/aclnn_return_code.md |
无问题 — 文本润色 |
docs/zh/context/broadcast_relationship.md |
无问题 — 代码块语言标记 tex→text |
docs/zh/context/compile_and_run_sample.md |
无问题 — 代码块语言修正 sh→cpp、标点修正 |
docs/zh/context/deduction_relationship.md |
无问题 — 全角括号修正 |
docs/zh/debug/cann_sim.md |
无问题 — 多处拼写/格式修正 |
docs/zh/develop/aicore_develop_guide.md |
无问题 — 大量代码块语言标记标准化、代码示例变量名修正 |
docs/zh/develop/aicpu_develop_guide.md |
无问题 — 类型名/常量名标准化 |
docs/zh/develop/cross_platform_migration_guide.md |
无问题 — 冒号、变量拼写修正 |
docs/zh/develop/graph_develop_guide.md |
无问题 — 代码块语言标记标准化 |
docs/zh/install/build.md |
无问题 — 间距修正 |
docs/zh/install/compile.md |
无问题 — 文本润色 |
docs/zh/install/dir_structure.md |
无问题 — 代码块语言标记修正 |
docs/zh/install/quick_install.md |
P1 — npu-smi 被错误改为 npu-sim |
docs/zh/invocation/quick_op_invocation.md |
P3 — CMakelists 应改为 CMakeLists |
docs/zh/op_api_list.md |
无问题 — 文本润色、Im2colBackward 描述修正 |
docs/zh/op_list.md |
无问题 — 文本润色、链接格式修正 |
整体风险评估
本次变更整体风险为 中低。大部分修改是代码块语言标记标准化(CPP/C++/Cpp → cpp、tex → text)、拼写修正和文本润色,属于文档质量改进。唯一需要关注的风险点是 quick_install.md 中 npu-smi 被误改为 npu-sim,该错误会使用户在安装指南中执行不存在的命令,建议优先修复。
| 类型 | 数量 |
|---|---|
| 🔴 阻塞 | 1 |
| 🟡 建议 | 0 |
⛔ 需要修改


28 天前 添加了label:stat/needs-squash
此处折叠了70条消息 查看更多
22 天前 添加了label:approved
21 天前 添加了label:lgtm
21 天前 解决了最后一个问题
21 天前 合入了pull request
描述
修改AIDD扫描的核心资料问题
关联的Issue
#651
文档更新
op_list.md
QUICKSTART.md
broadcast关系.md
两段式接口.md
aclnn返回码.md
...
类型标签