已合并
【docs】: 修改md格式问题 #4115
lwx1255555创建于 7月23日
【docs】: 修改md格式问题 #4115
已合并
lwx1255555创建于 7月23日
已删除 :develop合入到cann/gedevelop
lwx1255555
7月23日

Pull Request

描述

修改md格式问题

变更类型

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

关联的Issue

如何测试

描述测试此变更的步骤和前提条件:
1.
2.

核对清单

其他信息

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

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 lwx1255555 的贡献)
Llwx1255555
7月23日 添加了label:enhancement
Llwx1255555
7月23日 创建了 pull request,commit 8f4923d8
atomgit-bot
atomgit-bot
7月23日 评论:

变更摘要

本次 PR 主要针对项目中的 Markdown 文档进行了格式规范化处理,属于纯文档内容更新。变更涉及 68 个文件,整体以删除冗余、修正格式为主(净删除约 358 行),旨在提升文档的可读性和一致性。

主要改动

  • Markdown 格式规范化:统一修正了 68 个 Markdown 文件中的格式问题,包括但不限于标题层级、列表缩进、代码块标记、空行间距等不符合规范的写法
  • 冗余内容清理:删除了大量不必要的空行、重复描述和多余标记,使文档结构更加紧凑清晰(总删除 1304 行,新增 946 行)
likedislike
atomgit-bot
atomgit-bot
7月23日 评论:

代码审查

审查结束 — 总结

共审查 68 个文件,发现 5 个问题

优先级 数量 说明
P2 4 链接前缀错误,导致文档导航断裂
P3 1 Markdown 格式残留(多余 **

各文件审查结果:

  • dflow/dflow_api 目录(53 个文件)processpoint-class.md 存在 P3 格式残留(** 未完全移除),其余 52 个文件仅涉及去除 ** 加粗标记、去除空行或缩进调整,无实质问题。
  • llm_datadist 目录(15 个文件)
    • LlmDataDist-interface.mddata-structure.mddeprecated-interface.md(cpp 目录)以及 deprecated.md(python 目录)——这 4 个文件新增内容中的链接使用了错误的 ./cpp/./python/ 前缀,导致所有链接指向不存在的路径(如 .../cpp/cpp/...),文档导航完全断裂。
    • functions.md 修复了 Python 示例代码中的语法错误(raiseExceptionraise ExceptionraiseRuntimeErrorraise RuntimeError),无问题。
    • 其余 10 个文件仅涉及去除 ** 加粗标记、去除空行、缩进调整或 BOM 修复,无实质问题。

整体风险评估:中等。4 个 P2 问题导致 llm_datadist 新增的 4 个索引页面中所有链接全部断裂,用户无法通过这些页面导航到具体文档。建议在合入前修复这些链接前缀。

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

💬 仅评论

likedislike
CANN-robotCANN-robot成员
7月23日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
7月23日 评论:

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, lining23666, wangxiaotian995 (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成员
7月23日 将yangyongqiang0606,kobemini,tangqunzhang,xchu42,hugo111,lining23666,fu-jun2,depeng1994,wqtshg_wt,peiyang,shengnan666,zhangfan_hanq,zhanj,zhujingjing,Mexyy,wangxiaotian995,stevenaw0,yuht9设为评审人
CANN-robotCANN-robot成员
7月23日 将yangyongqiang0606,kobemini,tangqunzhang,xchu42,hugo111,lining23666,fu-jun2,depeng1994,wqtshg_wt,peiyang,shengnan666,zhangfan_hanq,zhanj,zhujingjing,Mexyy,wangxiaotian995,stevenaw0,yuht9设为审查人
Llwx1255555
7月23日 update merge request[project id: 8824148, iid: 4115, commit_id: 36ea8df7497376234bba6a0a54b81dbdbe784263] virtual merging success
Llwx1255555
7月23日 强制推送  1 个提交:75125636-20260723docs
Llwx1255555
7月23日 update merge request[project id: 8824148, iid: 4115, commit_id: f2b16acd0e0cf19a61da0aec1e109907cd9a34ec] virtual merging success
lwx1255555
7月23日 评论:

compile

likedislike
Llwx1255555
7月23日 update merge request[project id: 8824148, iid: 4115, commit_id: e4ca89ab7e43713c9412316897c7d504f3a56b8a] virtual merging success
CANN-robotCANN-robot成员
7月23日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
7月23日 评论:

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

任务名称状态日志下载链接
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-23 11:42:25]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月23日 评论:

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

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

[2026-07-23 11:23:17]    CI执行结束

likedislike
CANN-robotCANN-robot成员
7月23日 添加了label:api-check-pass
CANN-robotCANN-robot成员
7月23日 删除了label:api-check-pass
CANN-robot
CANN-robot成员
7月23日 评论:

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

任务名称状态日志下载链接
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-23 11:23:33]    CI执行结束

likedislike
atomgit-bot
atomgit-bot7月23日进行代码检视1
docs/zh/user_guides/llm_datadist/llm_datadist_api/cpp/data-structure.md
@@ -1,0 +6,4 @@
6+- [CacheIndex](CacheIndex.md)
7+- [Cache](Cache.md)
8+- [ClusterInfo-and-IpInfo](ClusterInfo-and-IpInfo.md)
9+- [KvCacheExtParam](KvCacheExtParam.md)
atomgit-bot
atomgit-bot7月23日评论:

🟡 Medium Priority

该文件位于 docs/zh/user_guides/llm_datadist/llm_datadist_api/cpp/data-structure.md,已在 cpp/ 目录下。但 diff 新增的所有链接(第3-9行)均使用了 ./cpp/ 前缀,例如 ./cpp/LlmRole.md。解析后路径为 .../cpp/cpp/LlmRole.md,该路径不存在。实际文件位于 .../cpp/LlmRole.md。同样的问题影响该文件中的所有 7 个链接。触发条件:用户点击任何链接都会 404。修复:将所有链接的 ./cpp/ 前缀移除。

建议:将所有链接中的 ./cpp/ 前缀移除。例如 ./cpp/LlmRole.mdLlmRole.md

likedislike
atomgit-bot
atomgit-bot7月23日进行代码检视1
docs/zh/user_guides/llm_datadist/llm_datadist_api/python/deprecated.md
@@ -1,0 +6,4 @@
6+ - [shape](shape.md)
7+- [Tensor](Tensor.md)
8+ - [Tensor-constructor](/Tensor-constructor.md)
9+ - [numpy](numpy.md)
atomgit-bot
atomgit-bot7月23日评论:

🟡 Medium Priority

该文件位于 docs/zh/user_guides/llm_datadist/llm_datadist_api/python/deprecated.md,已在 python/ 目录下。但 diff 新增的所有链接(第3-9行)均使用了 ./python/ 前缀,例如 ./python/TensorDesc.md。解析后路径为 .../python/python/TensorDesc.md,该路径不存在。实际文件位于 .../python/TensorDesc.md。同样的问题影响该文件中的所有 6 个链接。触发条件:用户点击任何链接都会 404。修复:将所有链接的 ./python/ 前缀移除。

建议:将所有链接中的 ./python/ 前缀移除。例如 ./python/TensorDesc.mdTensorDesc.md

likedislike
atomgit-bot
atomgit-bot7月23日进行代码检视1
docs/zh/user_guides/llm_datadist/llm_datadist_api/cpp/deprecated-interface.md
@@ -1,0 +1,3 @@
11# deprecated接口
2+ 
3+- [ClusterInfo-and-IpInfo(deprecated)](ClusterInfo-and-IpInfo-deprecated.md)
4+- [error-code(deprecated)](error-code-deprecated.md)
atomgit-bot
atomgit-bot7月23日评论:

🟡 Medium Priority

该文件位于 docs/zh/user_guides/llm_datadist/llm_datadist_api/cpp/deprecated-interface.md,已在 cpp/ 目录下。但 diff 新增的所有链接(第3-4行)均使用了 ./cpp/ 前缀,例如 ./cpp/ClusterInfo-and-IpInfo-deprecated.md。解析后路径为 .../cpp/cpp/ClusterInfo-and-IpInfo-deprecated.md,该路径不存在。实际文件位于 .../cpp/ClusterInfo-and-IpInfo-deprecated.md。触发条件:用户点击任何链接都会 404。修复:将所有链接的 ./cpp/ 前缀移除。

建议:将所有链接中的 ./cpp/ 前缀移除。例如 ./cpp/ClusterInfo-and-IpInfo-deprecated.mdClusterInfo-and-IpInfo-deprecated.md

likedislike
atomgit-bot
atomgit-bot7月23日进行代码检视1
docs/zh/user_guides/llm_datadist/llm_datadist_api/cpp/LlmDataDist-interface.md
@@ -1,0 +13,4 @@
13+- [PushKvCache](PushKvCache.md)
14+- [PushKvBlocks](PushKvBlocks.md)
15+- [AllocateCache](AllocateCache.md)
16+- [DeallocateCache](DeallocateCache.md)
atomgit-bot
atomgit-bot7月23日评论:

🟡 Medium Priority

该文件位于 docs/zh/user_guides/llm_datadist/llm_datadist_api/cpp/LlmDataDist-interface.md,已在 cpp/ 目录下。但 diff 新增的所有链接(第3-16行)均使用了 ./cpp/ 前缀,例如 ./cpp/LlmDataDist-constructor.md。从该文件位置解析后路径为 .../cpp/cpp/LlmDataDist-constructor.md,该路径不存在。实际文件位于 .../cpp/LlmDataDist-constructor.md。同样的问题影响该文件中的所有 14 个链接。触发条件:用户点击任何链接都会 404。修复:将所有链接的 ./cpp/ 前缀移除,改为直接的相对路径如 LlmDataDist-constructor.md./LlmDataDist-constructor.md

建议:将所有链接中的 ./cpp/ 前缀移除。例如 ./cpp/LlmDataDist-constructor.mdLlmDataDist-constructor.md

likedislike
CANN-robotCANN-robot成员
7月23日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
7月23日 添加了label:ci-pipeline-passed
lwx1255555
7月23日 评论:

compile

likedislike
CANN-robotCANN-robot成员
7月23日 删除了label:ci-pipeline-passed
CANN-robotCANN-robot成员
7月23日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
7月23日 评论:

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

任务名称状态日志下载链接
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-23 14:28:17]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月23日 评论:

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

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

[2026-07-23 14:20:06]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月23日 评论:

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

任务名称状态日志下载链接
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-23 14:19:48]    CI执行结束

likedislike
CANN-robotCANN-robot成员
7月23日 添加了label:api-check-pass
CANN-robotCANN-robot成员
7月23日 删除了label:api-check-pass
CANN-robotCANN-robot成员
7月23日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
7月23日 添加了label:ci-pipeline-passed
lining23666成员
7月23日 评论:

/lgtm

likedislike
wangxiaotian995成员
7月23日 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
7月23日 添加了label:lgtm
zhanj
zhanj成员
7月23日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
7月23日 添加了label:approved
CANN-robotCANN-robot成员
7月23日 解决了最后一个问题
CANN-robotCANN-robot成员
7月23日 合入了pull request