已合并
fix: Modify the AIDD docs issue #4332
zwj223创建于 21 天前
fix: Modify the AIDD docs issue #4332
已合并
Z
zwj223
21 天前
21 天前
## 描述
修改AIDD扫描的核心资料问题
## 关联的Issue
[#2415](https://gitcode.com/cann/ops-math/issues/2415)
## 文档更新
quick_op_invocation.md
cross_platform_migration_guide.md
op_list.md
aicpu_develop_guide.md
...
## 类型标签
- [ ] Bug修复
- [ ] 新特性
- [ ] 性能优化
- [x] 文档更新
- [ ] 其他,请描述:


Pull Request已成功合入, 合并人@CANN-robot
(感谢 zwj223 的贡献)atomgit-bot
21 天前 评论:
21 天前 评论:
变更摘要
本次 PR 主要针对 AIDD(AI 驱动开发)扫描中发现的文档资料问题进行集中修复,涉及多个 .md 文档的格式、内容勘误与规范性调整。改动范围覆盖算子调用说明、跨平台迁移指南、算子列表、AICore 开发指南等核心参考资料,整体行数变化较小(+93/-91),属于轻量级文档维护性更新。
主要改动
quick_op_invocation.md内容修正:调整了快速算子调用说明文档中的表述或格式问题,确保与 AIDD 扫描规范一致。cross_platform_migration_guide.md规范性修复:修正了跨平台迁移指南中的文档瑕疵,提升可读性与准确性。op_list.md勘误更新:对算子列表文档进行内容勘误,修复扫描发现的不规范描述。aicpu_develop_guide.md及其他文档同步修正:对 AICore 开发指南等多个文档进行了统一的格式与内容微调,消除 AIDD 扫描报告的问题项。


atomgit-bot
21 天前 评论:
21 天前 评论:
代码审查
审查总结
本次 PR 修改了 18 个文档文件,主要是 AIDD 扫描问题的修复,包括:代码围栏语言标记规范化(Cpp/CPP → cpp)、示例代码中的变量名修正(如 inputGMX → inputGMX_、pipe → pipe_)、错别字修正、标点符号规范化、JSON 尾随逗号移除、示例代码缺失变量声明补充等。
共发现 2 个问题:
| 优先级 | 数量 | 说明 |
|---|---|---|
| P1 | 1 | op_api_list.md 中 aclnnQr 链接路径错误(q_r → 应为 qr),导致文档断链 |
| P2 | 1 | quick_op_invocation.md 中 run.sh 脚本代码块语言标记错误(cmake → 应为 bash) |
各文件审查结果:
| 文件 | 结果 |
|---|---|
| CHANGELOG.md | 无问题 |
| docs/CONTRIBUTING_DOCS.md | 无问题 |
| docs/zh/context/broadcast_relationship.md | 无问题 |
| docs/zh/context/compile_and_run_sample.md | 无问题 |
| docs/zh/context/deduction_relationship.md | 无问题 |
| docs/zh/context/two_phase_api.md | 无问题 |
| docs/zh/debug/cann_sim.md | 无问题 |
| docs/zh/debug/op_debug_prof.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/spack_quick_install.md | 无问题 |
| docs/zh/invocation/quick_op_invocation.md | 1 个 P2 问题 |
| docs/zh/op_api_list.md | 1 个 P1 问题 |
| docs/zh/op_list.md | 无问题 |
整体风险评估:低风险。两个问题均为文档层面的错误(断链和语法高亮标记),不影响代码构建和运行。建议在合并前修复上述两个问题。
| 类型 | 数量 |
|---|---|
| 🔴 阻塞 | 1 |
| 🟡 建议 | 1 |
⛔ 需要修改


21 天前 添加了label:stat/needs-squash
此处折叠了46条消息 查看更多
14 天前 添加了label:api-check-pass
14 天前 删除了label:ci-pipeline-running
14 天前 添加了label:ci-pipeline-passed
14 天前 解决了最后一个问题
14 天前 合入了pull request