Star671
1091
代码
代码
Issues137
Pull Requests387
Actions
项目讨论
Wiki
分析
Star671
1091
已合并
【fix docs】增加错误码参考中英文文档，修改部分api参考的定义部分与模版一致 #4391
zangyan创建于 8月4日
【fix docs】增加错误码参考中英文文档，修改部分api参考的定义部分与模版一致 #4391
已合并
zangyan创建于 8月4日
从flyswa/hcommmaster合入到cann/hcommmaster
Z
zangyan成员
8月4日

描述

1、增加错误码参考中英文文档
2、修改部分api参考的md文档，使其与其他api md模板保持一致。

变更类型

请选择本次引入的变更类型：

关联的Issue

测试

已完成的测试用例和场景：
1.
2.

补充的UT用例：

文档更新

合入检查

likedislike
Pull Request已成功合入, 合并人@CANN-robot
（感谢 zangyan 的贡献）
Zzangyan成员
8月4日 创建了 pull request，commit a25c84f1
atomgit-bot
atomgit-bot
8月4日 评论：

变更摘要

本次 PR 为纯文档修正，主要对算子原型定义进行了统一修订，使其与 API 模板保持一致。变更涉及 19 个文件，净减少 40 行代码（新增 19 行，删除 59 行），核心目的是消除文档中算子原型描述与实际 API 模板之间的不一致，提升文档的准确性和可维护性。

主要改动

  • 算子原型定义对齐 API 模板：对多个算子文档中的原型定义进行了修正，删除了过时或与实际 API 模板不一致的描述内容，确保文档声明与代码实现严格对应
  • 冗余内容精简：移除了原型定义中的多余描述和注释，净删除 40 行内容，使文档更加简洁清晰
likedislike
不准确？
atomgit-bot
atomgit-bot
8月4日 评论：

代码审查

✅ 未发现问题

likedislike
不准确？
CANN-robotCANN-robot成员
8月4日 添加了label：cann-cla/yes
CANN-robot
CANN-robot成员
8月4日 评论：

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 ✅ 颜业峰, claire8090 (2/2) ✅ 颜业峰 (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
8月4日 将leabclove,yanglianxiang2,ccNeo824,chengym,ccl_ligang,linyf950,yanzhenghang,chenliang267,claire8090,yanyefeng,chenhao_,dingweiqin_57,songmingyang,wenxuemin,yangxiaoyuan,laodazhao1,yangshaohua,chenke2026,zhongqin2020,bz_lee,Innoecho,chenyia,temper7620,zhangxp1030,abiggg,lilin_137,lilianlin_hw,hulk1997,ouyangxizi设为评审人
CANN-robotCANN-robot成员
8月4日 将claire8090,yanyefeng,wenxuemin设为审查人
Z
zangyan成员
8月4日 评论：

compile

likedislike
Zzangyan成员
8月4日 预合并成功（commit_id: 398102efa695888f075e9cfab902a07e91bf1503）
CANN-robotCANN-robot成员
8月4日 添加了label：ci-pipeline-running
CANN-robot
CANN-robot成员
8月4日 评论：

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

任务名称状态日志下载链接
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
Check_Pr ✅ SUCCESS >>>>>
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
StaticCheck_codespell ✅ SUCCESS
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
ST_Test ✅ SUCCESS
API_Check ✅ SUCCESS >>>>>
codecheck ✅ SUCCESS >>>>>
codecheck_style ✅ SUCCESS >>>>>
UT_Test ✅ SUCCESS >>>>>
precommit ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>
PreSmoke_A3_npupool ✅ SUCCESS >>>>>

[2026-08-04 11:19:16]    CI执行结束

likedislike
CANN-robotCANN-robot成员
8月4日 添加了label：api-check-pass
CANN-robotCANN-robot成员
8月4日 删除了label：ci-pipeline-running
CANN-robotCANN-robot成员
8月4日 添加了label：ci-pipeline-passed
CANN-robot
CANN-robot成员
8月4日 评论：
流水线 PR-pipeline_cann_hcomm#16858 [ commitID：cae2d01b ] 已完成
likedislike
Zzangyan成员
8月5日 预合并成功（commit_id: 70c033ca4a301ecad1c669e1990ff0cd51cc8da0）
此处折叠了5条事件消息 查看更多
CANN-robotCANN-robot成员
8月5日 添加了label：cann-cla/yes
CANN-robot
CANN-robot成员
8月5日 评论：

Notification

This pull request has been changed(code update) or closed, so removes the following label(s): ci-pipeline-passed.

likedislike
Zzangyan成员
8月5日 预合并成功（commit_id: ed582720a8690942d1d299d9c6ea02380c9e6e5e）
此处折叠了8条事件消息 查看更多
CANN-robotCANN-robot成员
8月5日 删除了label：stat/needs-squash
CANN-robot
CANN-robot成员
8月5日 评论：

Notification

This pull request has been changed(code update) or closed, so removes the following label(s): stat/needs-squash.

likedislike
CANN-robotCANN-robot成员
8月5日 添加了label：cann-cla/yes
Zzangyan成员
8月5日 修改了pull request 的描述
Zzangyan成员
8月5日 修改标题为 “【fix docs】增加错误码参考中英文文档，修改部分api参考的定义部分与模版一致”，原标题为“【fix docs】修改算子原型定义，与API模版保持一致”
Z
zangyan成员
8月5日 评论：

compile

likedislike
Zzangyan成员
8月5日 预合并成功（commit_id: 3a9ae6fd1e943515651a0b2119ac70cf39fb403a）
CANN-robotCANN-robot成员
8月5日 删除了label：api-check-pass
CANN-robotCANN-robot成员
8月5日 添加了label：ci-pipeline-running
CANN-robot
CANN-robot成员
8月5日 评论：

流水线任务触发成功
任务链接 [7939f3558c9645bcb9747394494964b8][流水线指导]

任务名称状态日志下载链接
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
Check_Pr ✅ SUCCESS >>>>>
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
StaticCheck_codespell ⚠️ WARNING >>>>>
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
ST_Test ✅ SUCCESS
API_Check ✅ SUCCESS >>>>>
codecheck ✅ SUCCESS >>>>>
codecheck_style ✅ SUCCESS >>>>>
UT_Test ✅ SUCCESS >>>>>
precommit ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>
PreSmoke_A3_npupool ✅ SUCCESS >>>>>

[2026-08-05 17:18:50]    CI执行结束

likedislike
CANN-robotCANN-robot成员
8月5日 添加了label：api-check-pass
CANN-robotCANN-robot成员
8月5日 删除了label：ci-pipeline-running
CANN-robotCANN-robot成员
8月5日 添加了label：ci-pipeline-passed
CANN-robot
CANN-robot成员
8月5日 评论：
流水线 PR-pipeline_cann_hcomm#17062 [ commitID：b93b24db ] 已完成
likedislike
claire8090
claire8090成员
8月5日 评论：

/lgtm

likedislike
philo
philo成员
8月5日 评论：

/approve

likedislike
CANN-robotCANN-robot成员
8月5日 添加了label：lgtmapproved
CANN-robotCANN-robot成员
8月5日 合入了pull request