Star654
1090
代码
代码
Issues115
Pull Requests453
Actions
项目讨论
Wiki
分析
Star654
1090
已合并
[modify docs]修改文档中不规范用语 #5618
zangyan创建于 9月22日
[modify docs]修改文档中不规范用语 #5618
已合并
zangyan创建于 9月22日
从flyswa/hcommmaster合入到cann/hcommmaster
Z
zangyan成员
9月22日

描述

修改文档中不规范用语。

变更类型

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

关联的Issue

测试

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

补充的UT用例：

文档更新

合入检查

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

变更摘要

本 PR 为文档更新类改动，标题与描述均表明其目的是“修改文档中不规范用语”，即在文档中对表述进行规范化措辞调整，未涉及功能、接口或行为层面的变更。改动分布在多个文档文件中，整体属于文案层面的润色，不改变文档所描述的原有语义与结构。

主要改动

  • 文档用语规范化：根据 PR 描述，对文档中存在的不规范表述进行统一替换与修正，使其符合规范用语要求。
  • 涉及范围：改动覆盖 9 个文件，均集中于文档类内容，未触及代码逻辑、配置项或接口定义。
  • 变更性质：以措辞调整为主，新增与删除行数接近，属于等量替换式的文字修订，不改变文档原有含义。
likedislike
不准确？
atomgit-bot
atomgit-bot
9月22日 评论：

🤖 本次改动均为数据 / 生成 / 二进制文件（如测试用例、锁文件、媒体资源），没有可审查的代码逻辑，已跳过 AI 代码审查。

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

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.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.

PR Approval Progress

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

Module Approval Details

module lgtm status approve status
docs ✅ 袁滔, 颜业峰 (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成员
9月22日 将leabclove,Flashfuture,yanglianxiang2,linyf950,yanzhenghang,chenliang267,claire8090,yanyefeng,chenhao_,dingweiqin_57,songmingyang,wenxuemin,LQ_OY,yangxiaoyuan,laodazhao1,yangshaohua,chenke2026,zhongqin2020,bz_lee,Innoecho,chenyia,temper7620,zhangxp1030,lilin_137,hulk1997,ouyangxizi,one_random设为评审人
CANN-robotCANN-robot成员
9月22日 将claire8090设为审查人
Z
zangyan成员
9月22日 评论：

compile

likedislike
Zzangyan成员
9月22日 预合并成功（commit_id: 4f7b6a023e2392b31c4b2ddd1cdf77eafa6b5f0b）
CANN-robot
CANN-robot成员
9月22日 评论：
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robot成员
9月22日 添加了label：ci-pipeline-running
CANN-robotCANN-robot成员
9月22日 删除了label：ci-pipeline-running
CANN-robotCANN-robot成员
9月22日 添加了label：ci-pipeline-passed
philo
philo成员
9月22日 评论：

/lgtm

likedislike
欧阳茜
欧阳茜成员9月23日进行代码检视1
docs/zh/api_ref/comm_mgr_c/data_type_definition/HcclCommConfig.md
@@ -105,3 +105,3 @@
105105 - 该配置项支持的算子及约束限制参见配置“3”。
106106 
107- - 5：通信算子在CCU（Collective Communication Unit，集合通信加速单元）展开，使用MS（Memory Slice）模式。Ascend 950PR不支持此配置。
107+ - 5：通信算子在CCU（Collective Communication Unit，集合通信加速单元）展开，使用CcuBuffer进行内存转写。Ascend 950PR不支持此配置。
欧阳茜
欧阳茜9月23日评论：

[MEDIUM] 同一 PR 内对 CCU_MS 模式的描述用词不一致：“内存转写” vs “内存读写”

本 PR 在 HcclCommConfig.md:107 将模式5描述为“使用CcuBuffer进行内存转写”，但在同一 PR 修改的 HcclOpExpansionMode.md:16 中描述为“使用CcuBuffer进行内存读写”，且本文件 109 行也写作“内存读写带宽”。“内存转写”非规范用语，且与同 PR 其他两处表述冲突。建议统一为“使用CcuBuffer进行内存读写。”，与 HcclOpExpansionMode.md 保持一致。

likedislike
欧阳茜
欧阳茜成员9月23日进行代码检视2
docs/en/error_codes/EI0001-Config_Error_Invalid_Environment_Variable.md
@@ -18,3 +18,3 @@
1818## Locating the fault in plog
1919 
20-The error format above is used for ERROR MESSAGE reporting. For Ascend 950PR&950DT series products, the corresponding plog contains the environment variable name, configured value, and reason, with the following search keywords:
20+The error format above is used for ERROR MESSAGE reporting. For Ascend 950PR&950DT products, the corresponding plog contains the environment variable name, configured value, and reason, with the following search keywords:
欧阳茜
欧阳茜9月23日评论：

[MEDIUM] en 删除“series”后与中文文档不一致（950PR&950DT系列产品）

本行将“For Ascend 950PR&950DT series products”改为“For Ascend 950PR&950DT products”，但对应的中文文档 docs/zh/error_codes/EI0001-Config_Error_Invalid_Environment_Variable.md:20 仍保留“针对Ascend 950PR&950DT系列产品”，且仓内中文 API 文档（如 HcclCommQueryCcuIns.md:6、HcommChannelCreateWithConfig.md:6 等）均使用“950PR&950DT系列产品”表述。中英文文档现不一致。建议保持中英文对齐：若认为“series products”不准确，同步将中文的“系列”一并去掉；否则英文保留“series products”。

likedislike
Z
zangyan成员
9月23日 评论：

非问题，英文统一为products，复数代表系列

欧阳茜
欧阳茜成员9月23日进行代码检视2
docs/zh/architecture/architecture-brief.md
@@ -80,3 +80,3 @@
8080| **通信设备(Endpoint)** | 网络通信的逻辑接口，包含协议与地址 | NPU 网口 / Host NIC |
8181| **通信通道(Channel)** | 两端通信设备间的数据通道（含同步 Notify） | RoCE QP / UB Jetty 连接 |
82-| **通信内存(CommMem)** | 注册到通信域、可被通信设备(Endpoint)访问的内存段 | NPU HBM / Host 内存 |
82+| **通信内存(CommMem)** | 注册到通信域、可被通信设备(Endpoint)访问的内存段 | NPU片上内存 / Host内存 |
欧阳茜
欧阳茜9月23日评论：

[LOW] 表格内空格格式不一致：“Host内存”缺少空格

本行改为“NPU片上内存 / Host内存”，其中“Host内存”之间没有空格；改动前的“Host 内存”及同表其他单元格（如“NPU 网口 / Host NIC”“RoCE QP / UB Jetty 连接”）均采用中英文混排空格风格。建议统一为“NPU片上内存 / Host 内存”（或整体加空格为“NPU 片上内存 / Host 内存”）。

likedislike
Z
zangyan成员
9月23日 评论：

非问题，文档写作规范Host与内存间无空格

欧阳茜
欧阳茜成员
9月23日 评论：

代码检视汇总报告

  • PR: #5618
  • 标题: [modify docs]修改文档中不规范用语
  • 检视基准: head 03fa77651450 / base acb5a4aa7b97
  • 检视意见: 3 条（CRITICAL 0 / HIGH 0 / MEDIUM 2 / LOW 1）
# 级别 位置 维度 摘要
1 MEDIUM docs/zh/api_ref/comm_mgr_c/data_type_definition/HcclCommConfig.md:107 文档一致性 同一 PR 内对 CCU_MS 模式的描述用词不一致：“内存转写” vs “内存读写”
2 MEDIUM docs/en/error_codes/EI0001-Config_Error_Invalid_Environment_Variable.md:20 文档一致性 en 删除“series”后与中文文档不一致（950PR&950DT系列产品）
3 LOW docs/zh/architecture/architecture-brief.md:82 命名与风格 表格内空格格式不一致：“Host内存”缺少空格

详细意见已按行提交（见上方行内评论）。每条意见均含建议修复方式。

likedislike
claire8090
claire8090成员
9月23日 评论：

/approve

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