Merged
修复资料问题,更新文档检查skill #3668
修复资料问题,更新文档检查skill #3668
Merged
GRJ_XIDUOAdd on Jun 26
GRJ_XIDUO
GRJ_XIDUOCollaborators
Jun 26

描述

修复资料错误:语病和不一致变量命名

关联的Issue

测试

文档更新

类型标签

likedislike
Pull Request has been successfully merged by CANN-robot.
(Thank you for GRJ_XIDUO's contribution.)
GRJ_XIDUOGRJ_XIDUOCollaborators
Jun 26 Created pull request, commit bca7f18e
CANN-robotCANN-robotCollaborators
Jun 26 Added label: cann-cla/yes
GRJ_XIDUOGRJ_XIDUOCollaborators
Jun 26 Associated issue: [算子开发][内测体验][AscendC][Documentation|文档反馈]: CrossCoreSetFlag/CrossCoreWaitFlag 约束说明中"情况如不:"应为"情况如下:"
CANN-robot
CANN-robotCollaborators
Jun 26 Comments:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here。
You can get sig-info at here


PR Approval Progress

✅ Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
docs ✅ munanhw, wuyang_hw, bianque (3/2) ✅ munanhw (1/1)
repo-cann/asc-devkit ✅ DragonBornHD84, bianque, wuyang_hw (3/2) ✅ DragonBornHD84 (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

GRJ_XIDUO, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
gao_dafaCollaborators
Jun 26 Comments:

GRJ_XIDUO,感谢您的提交,建议在完成PR充分自验证后,再触发线上构建任务。

若您的PR已具备检视条件,可根据下表的责任田,@对应的committer进行代码检视,我们会在第一时间对您的提交进行处理。

代码责任田:

module committer
adv_api chenyiyuan, wuyang_hw
basic_api chenyiyuan, wuyang_hw
c_api pangfd, yue_mo_du_qian
cmake xun_zhuge, DragonBornHD84
docs munanhw, ai_xin
examples changxianyu, bianque
simt_api wulinyu, zhanghao_0689
scripts xun_zhuge, kevin365
tools YANXI_ZHAO, XuebinYang, sjtulxh

💡 如您不确定可以@谁,可以直接@我或者ascend-c sig的maintainer,xun_zhuge和ascendhjh,我们会为您分配合适的committer进行代码检视。

再次感谢您参与CANN的社区贡献。

likedislike
GRJ_XIDUOGRJ_XIDUOCollaborators
Jun 26 Pre merge succeeded (commit_id: d6d37c7dd8dd708791170f64a6b9b30a976c511a)
GRJ_XIDUOGRJ_XIDUOCollaborators
Jun 26 Pushed 1 commits:083d77c5-修复资料低级错误
GRJ_XIDUOGRJ_XIDUOCollaborators
Jun 26 Pre merge succeeded (commit_id: b5779096e296b368e0bbc4e7ee3590fef98a1b6a)
CANN-robotCANN-robotCollaborators
Jun 26 Added label: stat/needs-squash
GRJ_XIDUO
GRJ_XIDUOCollaborators
Jun 26 Comments:

compile

likedislike
GRJ_XIDUOGRJ_XIDUOCollaborators
Jun 26 Pre merge succeeded (commit_id: efdc2af0b71744f95613907b6071a963e8a6eac8)
CANN-robotCANN-robotCollaborators
Jun 26 Added label: ci-pipeline-running
CANN-robot
CANN-robotCollaborators
Jun 26 Comments:

流水线任务触发成功
任务链接 [248e4e318c8044a99bfcbe38ce857af7][流水线指导]

任务名称状态日志下载链接
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck ✅ SUCCESS >>>>>
codecheck_Pr ✅ SUCCESS
pre_comment ✅ SUCCESS >>>>>
StaticCheck_codespell_check ✅ SUCCESS
StaticCheck_link_validity_check ✅ SUCCESS
StaticCheck_resource_existence_check ✅ SUCCESS
StaticCheck_tag_closed_check ✅ SUCCESS
StaticCheck_markdownlint ⚠️ WARNING >>>>>
codecheck_codestyle ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>> >>>>>

[2026-06-26 19:25:58]    CI执行结束

likedislike
CANN-robot
CANN-robotCollaborators
Jun 26 Comments:

流水线任务触发成功
任务链接 [56ba535e7ed344ed8e9bfd8cbf171fa8][流水线指导]

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
UT_Test_adv_test_one ✅ SUCCESS
UT_Test_adv_test_two ✅ SUCCESS
UT_Test_basic_test_one ✅ SUCCESS
UT_Test_basic_test_two ✅ SUCCESS
UT_Test_basic_test_three ✅ SUCCESS
UT_Test_basic_test_four ✅ SUCCESS
UT_Test_basic_test_five ✅ SUCCESS
UT_Test_arm ✅ SUCCESS
UT_Test_report ✅ SUCCESS >>>>>

[2026-06-26 19:26:49]    CI执行结束

likedislike
CANN-robot
CANN-robotCollaborators
Jun 26 Comments:

流水线任务触发成功
任务链接 [2f42c0b66e0c478fa9e5574489c373df][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>

[2026-06-26 19:25:52]    CI执行结束

likedislike
atomgit-bot
atomgit-bot
Jun 26 Comments:

变更摘要

本次 PR 主要针对项目文档进行修复和优化,修正了文档中存在的语病问题以及变量命名不一致的情况,并更新了文档检查 Skill 的相关配置。整体变更涉及 5 个文件,以文档质量提升和一致性修正为核心目标。

主要改动

  • 修复文档语病:修正了多份文档中存在的语法错误和表达不清的问题,提升文档的可读性和专业性。
  • 统一不一致的变量命名:对文档中出现的变量命名不一致之处进行了规范化处理,确保示例代码中的命名风格保持一致。
  • 更新文档检查 Skill:调整了文档检查相关的 Skill 配置,以更好地适配当前的文档规范和检查流程。
likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
Jun 26 Removed label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
Jun 26 Added label: ci-pipeline-passed
atomgit-bot
atomgit-bot
Jun 26 Comments:

代码审查

All files reviewed. Now I'll produce the closing summary.


审查总结

本次审查覆盖了全部 5 个变更文件:

文件 审查结论
.agent/skills/asc-doc-checker/SKILL.md 发现 2 个 P3 问题
.agent/skills/asc-doc-checker/references/芯片与标签映射关系.md 无问题
docs/api/SIMD-API/…/CrossCoreSetFlag(ISASI).md 无问题("如不"→"如下"笔误修复正确)
docs/api/SIMD-API/…/CrossCoreWaitFlag(ISASI).md 无问题("如不"→"如下"笔误修复正确)
docs/api/SIMD-API/…/数学计算/CeilDivision.md 无问题(多余空格修复+示例代码变量修正均正确)

按优先级统计:

  • P0:0
  • P1:0
  • P2:0
  • P3:2(均为文档规范一致性问题)

整体风险判断:低风险。本 PR 是文档修正,核心改动(修复"如不"笔误、统一产品名称空格、修正示例代码中未定义变量)均正确有益。发现的 2 个 P3 问题均为 SKILL.md 内部的术语/数据一致性问题,不影响线上行为,但建议一并修复以避免下游文档检查产生误报。

⚠️ 已识别出整体风险,但无法提取行内评论,请参考整体评估。

likedislike
Incorrect?
bianqueCollaborators
Jun 26 Comments:

/lgtm

likedislike
Yifan WangCollaborators
Jun 26 Comments:

[V-1] P2 | CR-6 | 与PR #3656存在重叠

本PR修改的3个文件(CrossCoreSetFlag.md、CrossCoreWaitFlag.md、CeilDivision.md)与PR #3656完全重叠——两处"如不"→"如下"笔误修复和CeilDivision变量名修正内容一致。

但本PR额外修复了CeilDivision中的两处小问题("AI Core"空格移除、"表 1"→"表1"),比#3656更完整。

建议: 合入本PR(#3668),关闭#3656即可,避免重复合入。


此评论由AI生成,如有异议,请回复帮助我更快成长:)

likedislike
munanhwCollaborators
Jun 27 Comments:

/approve

likedislike
gao_dafaCollaborators
Jun 27 Comments:

/lgtm

likedislike
CANN-robot
CANN-robotCollaborators
Jun 27 Comments:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
gao_dafa

likedislike
吴洋Collaborators
Jun 27 Comments:

/lgtm

likedislike
CANN-robot
CANN-robotCollaborators
Jun 27 Comments:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
gao_dafa

likedislike
CANN-robotCANN-robotCollaborators
Jun 27 Added label: lgtm
DragonBornHD84Collaborators
Jun 27 Comments:

/approve

likedislike
CANN-robot
CANN-robotCollaborators
Jun 27 Comments:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
gao_dafa

likedislike
CANN-robotCANN-robotCollaborators
Jun 27 Added label: approved
CANN-robotCANN-robotCollaborators
Jun 27 Merged pull request