Star649
434
代码
代码
Issues31
Pull Requests109
Actions
项目讨论
Wiki
分析
Star649
434
已合并
【docs】修改产品md文档中的多余字符 #4209
lwx1255555创建于 22 天前
【docs】修改产品md文档中的多余字符 #4209
已合并
lwx1255555创建于 22 天前
从已删除 :develop合入到cann/gedevelop
L
lwx1255555
22 天前

Pull Request

描述

修改md文档中的多余字符

变更类型

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

关联的Issue

如何测试

描述测试此变更的步骤和前提条件：
1.已经自检
2.已经使用doctools检查

核对清单

其他信息

在此添加任何其他关于本次 PR 的说明。

likedislike
Pull Request已成功合入, 合并人@CANN-robot
（感谢 lwx1255555 的贡献）
Llwx1255555
22 天前 添加了label：enhancement
Llwx1255555
22 天前 创建了 pull request，commit 28a7e155
atomgit-bot
atomgit-bot
22 天前 评论：

变更摘要

本次 PR 主要对产品相关的 Markdown 文档进行批量清理，修正了文档中的多余字符（如多余的标点、空格、换行或其他不规范字符）。变更涉及 507 个 .md 文件，净减少约 29 行内容，属于纯文档内容更新，不涉及任何代码逻辑或功能变更。

主要改动

  • 批量修正多余字符：对 507 个产品 Markdown 文档进行统一清理，移除或修正了文档中存在的多余字符，使文档格式更加规范统一。
  • 文档内容小幅精简：总计删除 606 行、新增 577 行，净减少 29 行，反映出对冗余内容的删减和必要处的补充修正。
  • 使用 doctools 工具校验：变更后已通过 doctools 工具检查，确保文档格式符合项目规范。
likedislike
atomgit-bot
atomgit-bot
22 天前 评论：

代码审查

The grep confirms the typo is unique to FuncProcessPoint.md. Now I have my complete review.

审查结论

本 PR 共修改 499 个文件，变更模式主要分为两类：

  1. 约 490+ 个文件的 BOM（Byte Order Mark）字符清除：将 # 替换为 #（即去除文件首行的不可见 Unicode BOM 字符）
  2. 少量文件的实质性文本修正：语法修正、拼写修正、HTML 实体转义、表格重构等

各文件审查结果

发现 1 个问题：

# 文件 问题
1 docs/zh/user_guides/dflow/dflow_api/python/FuncProcessPoint.md (第 129 行) CMakeLists 示例代码中 X86 分支的错误消息 "Unsupporte'd compile X86 target!" 存在拼写错误，应为 "Unsupported compile X86 target!"

P2 级问题：1 个（拼写错误引入用户可复制的错误代码示例中，但影响范围有限，仅为文档）。

审查通过的变更类型

  • BOM 清除（~490+ 文件）：仅移除不可见的 UTF-8 BOM 字节序列，不改变任何可见内容。✅
  • API 名称大小写修正（Proc.md、multi-func-handler.md）：SetRetcode → SetRetCode，与 API 定义一致。✅
  • 语法/拼写修正（setcompileconfig-functionpp-class.md、FuncProcessPoint.md 部分行）：Unsupport → Unsupported，is exist → exists，If there have → if there are，INVAILD → INVALID 等。✅（除上述 1 处笔误外）
  • HTML 实体转义（udf-api-list.md）：<T> 中的 </> 转义为 \</\>，修复 Markdown 渲染问题。✅
  • 表格重构（udf-log-api-intro.md）：将多行扩展表格合并为单行简洁表格。✅
  • 新增内容（dflow/introduction.md、llm_datadist/introduction.md）：添加产品支持情况和使用场景表。✅
  • 内容清理（special_topics.md、appendices.md、dataflow_running.md 等）：删除多余字符/空格/重排。✅

整体风险评估：低风险

此 PR 的核心变更是清除文档文件中的不可见 BOM 字符（约占变更量的 98%），对文档内容无实质影响。唯一的实际问题是一处笔误（Unsupporte'd），将该文档中 X86 编译分支的示例错误消息写错了一个字符。建议在合并前修正该行，其余变更均为安全的文档清理工作。

类型 数量
🔴 阻塞 0
🟡 建议 1

💬 仅评论

likedislike
CANN-robotCANN-robot成员
22 天前 添加了label：stat/needs-squash
CANN-robotCANN-robot成员
22 天前 添加了label：cann-cla/yes
CANN-robot
CANN-robot成员
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

PR Approval Progress

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

Module Approval Details

module lgtm status approve status
repo-cann/ge ✅ zhanj, wangxiaotian995, lining23666 (3/2) ✅ zhanj (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
22 天前 将yangyongqiang0606,kobemini,tangqunzhang,xchu42,hugo111,lining23666,fu-jun2,depeng1994,wqtshg_wt,peiyang,shengnan666,zhangfan_hanq,zhanj,zhujingjing,Mexyy,wangxiaotian995,stevenaw0,yuht9设为评审人
CANN-robotCANN-robot成员
22 天前 将yangyongqiang0606,kobemini,tangqunzhang,xchu42,hugo111,lining23666,fu-jun2,depeng1994,wqtshg_wt,peiyang,shengnan666,zhangfan_hanq,zhanj,zhujingjing,Mexyy,wangxiaotian995,stevenaw0,yuht9设为审查人
L
lwx1255555
22 天前 评论：

compile

likedislike
Llwx1255555
22 天前 update merge request[project id: 8824148, iid: 4209, commit_id: d8becf9a6eee96d17c847f81da6968e875783d94] virtual merging success
CANN-robotCANN-robot成员
22 天前 添加了label：ci-pipeline-running
CANN-robot
CANN-robot成员
22 天前 评论：

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

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
Compile_ARM_compiler ✅ SUCCESS >>>>> >>>>>
Compile_ARM_executor ✅ SUCCESS >>>>> >>>>>
Compile_ARM_dflow ✅ SUCCESS >>>>> >>>>>
API_Check ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>

[2026-07-30 17:35:51]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
22 天前 评论：

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

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
Compile_X86_compiler ✅ SUCCESS >>>>> >>>>>
Compile_X86_executor ✅ SUCCESS >>>>> >>>>>
Compile_X86_dflow ✅ SUCCESS >>>>> >>>>>
UT_Test_dflow ✅ SUCCESS
UT_Test_ge_common ✅ SUCCESS
UT_Test_parser ✅ SUCCESS
UT_Test_python ✅ SUCCESS >>>>>
UT_Test_rt ✅ SUCCESS
UT_Test_acl ✅ SUCCESS
UT_Test_autofuse ✅ SUCCESS
UT_Test_executor ✅ SUCCESS
UT_Test_autofuse_ascendc_api ✅ SUCCESS
ST_Test_dflow ✅ SUCCESS
ST_Test_ge_common ✅ SUCCESS
ST_Test_parser ✅ SUCCESS
ST_Test_python ✅ SUCCESS >>>>>
ST_Test_rt ✅ SUCCESS
ST_Test_autofuse ✅ SUCCESS
ST_Test_executor ✅ SUCCESS
ST_Test_hetero ✅ SUCCESS
ST_Test_autofuse_ascendc_api ✅ SUCCESS
ST_Test_autofuse_e2e ✅ SUCCESS
UT_Test_fe ✅ SUCCESS
UT_Test_tefusion ✅ SUCCESS
ST_Test_fe ✅ SUCCESS
ST_Test_tefusion ✅ SUCCESS
ST_Test_ge_common_atc ✅ SUCCESS
UT_Test_Report_graphengine ✅ SUCCESS >>>>>
UT_Test_Report_ge_executor_c ✅ SUCCESS >>>>>
UT_Test_Report_ge_autofuse ✅ SUCCESS >>>>>
ST_Test_Report_graphengine ✅ SUCCESS >>>>>
ST_Test_Report_ge_executor_c ✅ SUCCESS >>>>>
ST_Test_Report_ge_autofuse ✅ SUCCESS >>>>>
UT_Test_Report_fe ✅ SUCCESS >>>>>
ST_Test_Report_fe ✅ SUCCESS >>>>>

[2026-07-30 17:37:31]    CI执行结束

likedislike
CANN-robotCANN-robot成员
22 天前 添加了label：api-check-pass
CANN-robot
CANN-robot成员
22 天前 评论：

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

任务名称状态日志下载链接
codecheck_Pr ✅ SUCCESS
antipoison ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
codecheck_dt ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>>
StaticCheck_codespell ⚠️ WARNING >>>>>
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS

[2026-07-30 17:36:03]    CI执行结束

likedislike
CANN-robotCANN-robot成员
22 天前 删除了label：api-check-pass
CANN-robotCANN-robot成员
22 天前 删除了label：ci-pipeline-running
CANN-robotCANN-robot成员
22 天前 添加了label：ci-pipeline-passed
L
lining23666成员
22 天前 评论：

/lgtm

likedislike
W
wangxiaotian995成员
22 天前 评论：

/lgtm

likedislike
CANN-robotCANN-robot成员
22 天前 添加了label：lgtm
atomgit-bot
atomgit-bot21 天前进行代码检视1
docs/zh/user_guides/dflow/dflow_api/python/FuncProcessPoint.md
@@ -127,3 +127,3 @@
127127 message(STATUS "x86 compiler enter")
128128 # if unsupported current resource type, please uncomment the next line.
129- # message(FATAL_ERROR "Unsupport compile X86 target!")
129+ # message(FATAL_ERROR "Unsupporte'd compile X86 target!")
atomgit-bot
atomgit-bot21 天前评论：

🟡 Medium Priority

在 FuncProcessPoint.md 第 129 行的 CMakeLists 代码示例中，本应将 "Unsupport compile X86 target!" 修正为 "Unsupported compile X86 target!"（与 Ascend/Aarch64 分支保持一致），但实际被替换为了拼写错误的 "Unsupporte'd compile X86 target!"。

对比同一个 PR 中对 C++ 版本对应文件 setcompileconfig-functionpp-class.md 的修改，其三处 Unsupport → Unsupported 的修改均正确。但 Python 版本文档中 X86 分支的修改引入了笔误：在 "Unsupported" 的 "d" 之前错误地插入了一个单引号（'），导致变成 Unsupporte'd。

该错误信息是用户按照文档指导解开注释后实际会触发的 CMake FATAL_ERROR 消息，属于文档中可被用户直接复制使用的示例代码。拼写错误会误导用户，降低文档的专业性和可信度。

建议将 "Unsupporte'd compile X86 target!" 修正为 "Unsupported compile X86 target!"，与同一代码块中 Ascend 和 Aarch64 分支的错误消息拼写保持一致。

建议：将 "Unsupporte'd compile X86 target!" 修正为 "Unsupported compile X86 target!"，与 Ascend/Aarch64 分支保持一致。

改动建议
129
- # message(FATAL_ERROR "Unsupporte'd compile X86 target!")
129
+ # message(FATAL_ERROR "Unsupported compile X86 target!")
应用建议
likedislike
zhanj
zhanj成员
21 天前 评论：

/approve

likedislike
CANN-robotCANN-robot成员
21 天前 添加了label：approved
CANN-robotCANN-robot成员
21 天前 解决了最后一个问题
CANN-robotCANN-robot成员
21 天前 合入了pull request