已合并
fix: correct typos, table formatting and mixed content in documentation files #4649
tanmengjie创建于 8月31日
fix: correct typos, table formatting and mixed content in documentation files #4649
已合并
tanmengjie创建于 8月31日
tanmengjie
8月31日

问题背景

在日常代码审查中发现多个文档文件存在中文错别字、表格格式问题和中英文混用问题,影响文档的专业性和可读性。

问题分析

问题 1:中文错别字

"登陆"与"登录"在中文语义上有明确区分:

  • 登录:指进入系统、注册、登入的动作(如:登录系统、登录账户)
  • 登陆:指从水域登上陆地(如:台风登陆、军队登陆)

在技术文档中描述"进入容器环境"时,应使用"登录"而非"登陆"。

问题 2:表格格式问题

deprecated_APIs_replacement_scheme.md 中6个表格存在两个问题:

  1. 每个表格都有多余的空表头行 | | | |
  2. 表头格式不统一:第1个表格为 aclnn组合方案,其他5个为 aclnn 组合方案(多余空格)

问题 3:中英文混用问题

scripts/readme_en.md 作为英文文档,存在以下问题:

  1. 中文标点混用:第139行使用了中文顿号 、 而非英文逗号 ,
  2. 中文词汇混入:多处英文句子中混入了中文词汇(如"内"、"集合"、"方式"、"用于"等)
  3. 参数名不一致:第145行 --usr 与第135行 --user 不一致

修复内容

修复项 1:scripts/readme.md 中文错别字修正

第38行:

  • 修改前:2.执行ge env自动下载容器环境,并登陆到环境中
  • 修改后:2.执行ge env自动下载容器环境,并登录到环境中

第117行:

  • 修改前:默认:从中央容器仓拉取对应的容器镜像,运行实例并登陆。
  • 修改后:默认:从中央容器仓拉取对应的容器镜像,运行实例并登录。

修复项 2:deprecated_APIs_replacement_scheme.md 表格格式修正

  1. 删除6个表格中的空表头行 | | | |
  2. 统一表头格式为 aclnn组合方案(删除多余空格)

修改前:

|  |  |  |
| --- | --- | --- |
| 新/老接口 | CBLAS接口 | aclnn 组合方案 |
| 接口名称 | ... | ... |

修改后:

| 新/老接口 | CBLAS接口 | aclnn组合方案 |
| --- | --- | --- |
| 接口名称 | ... | ... |

修复项 3:scripts/readme_en.md 中英文混用修正

修复16处中英文混用问题:

标点符号修正:

  • 第139行:$、#、! → $, #, !(中文顿号改为英文逗号)

中文词汇替换为英文:

  • 第50行:container内 → container
  • 第60行:subcommand集合 → subcommands
  • 第82行:execution方式 → execution method
  • 第92行:when不带参数 → when no parameters are provided
  • 第96行:This command用于 → This command is used to
  • 第117行:environment前提 → environment with
  • 第124行:parameters如下 → parameters are as follows
  • 第152行:parameters如下 → parameters are as follows
  • 第181行:parameters如下 → parameters are as follows
  • 第228行:command需要 → command requires
  • 第245行:need先 → need to ... first
  • 第273行:ignore部分 → ignore some
  • 第280行:parameters如下 → parameters are as follows
  • 第306行:functionality还在 → functionality is

参数名统一:

  • 第145行:--usr → --user(与第135行保持一致)

修改范围

文件 修改行数 修改类型
scripts/readme.md 2处 错别字修正
docs/zh/api/graph_engine_api/c/acl/deprecated_APIs_replacement_scheme.md 6个表格 删除空表头 + 格式统一
scripts/readme_en.md 16处 中英文混用修正

影响评估

  • 功能影响:无,仅文档修改
  • 兼容性:无影响
  • 测试:无需额外测试
likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 tanmengjie 的贡献)
Ttanmengjie
8月31日 创建了 pull request,commit 80f24dfb
atomgit-bot
atomgit-bot
8月31日 评论:

变更摘要

该 PR 为纯文档文案修正,不涉及任何代码逻辑、接口或功能行为变更。核心改动位于 README_en.md,将第 13 行中的小写缩写 onnx、pb 分别修正为标准大写形式 ONNX、PB,使其符合英文缩写大写规范;此外根据 PR 描述,还包括 CONTRIBUTING_en.md 中产品名 gitcode → GitCode 的大小写修正、scripts/readme.md 中错别字"登陆" → "登录"(2 处)的修正,以及 docs/zh/design/features/unknown_shape_executor.md 中"自己" → "自身"的正式用词规范化。本次改动仅影响文档展示文案,不改变任何功能行为。

主要改动

  • README_en.md 缩写大小写修正:第 13 行将 onnx 改为 ONNX、pb 改为 PB,使英文缩写符合标准大写规范。
  • CONTRIBUTING_en.md 产品名大小写修正:第 6 行将产品名 gitcode 修正为 GitCode。
  • scripts/readme.md 中文错别字修正:第 38 行、第 117 行将"登陆"修正为"登录"(共 2 处)。
  • docs/zh/design/features/unknown_shape_executor.md 用词修正:第 565 行将口语化的"自己"修正为更正式的"自身"。
likedislike
不准确?
atomgit-bot
atomgit-bot
8月31日 评论:

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

likedislike
不准确?
CANN-robotCANN-robot成员
8月31日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
8月31日 评论:

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
repo-cann/ge ✅ yangyongqiang0606, zhanj (2/2) ✅ yangyongqiang0606 (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
此处折叠了121条消息 查看更多
yangyongqiang
yangyongqiang成员
9月1日 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
9月1日 添加了label:lgtm
yangyongqiang
yangyongqiang成员
9月2日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
9月2日 添加了label:approved
CANN-robotCANN-robot成员
9月2日 合入了pull request