已合并
refactor: docs目录下文件名中英文括号替换为下划线命名 #4450
munanhw创建于 7月18日
refactor: docs目录下文件名中英文括号替换为下划线命名 #4450
已合并
munanhw创建于 7月18日
munanhw成员
7月18日

描述

refactor: docs目录下文件名中英文括号替换为下划线命名

关联的Issue

测试

文档更新

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 munanhw 的贡献)
Mmunanhw成员
7月18日 创建了 pull request,commit 9e713379
atomgit-bot
atomgit-bot
7月18日 评论:

变更摘要

本次 PR 对 docs 目录下的文档资源文件进行批量重命名重构,将文件名中的中文括号「(」「)」和英文括号「(」「)」统一替换为下划线「_」命名风格,并同步更新所有文档中对这些文件的引用路径。该变更属于纯文档整理,不涉及任何代码逻辑或功能改动。

主要改动

  • 文件名规范化:将 docs 目录下包含中文括号「()」或英文括号「()」的文件名,统一将括号字符替换为下划线,使命名风格更加一致且避免潜在的文件系统兼容性问题。
  • 引用路径同步更新:在所有受影响的 350 个文档文件中,将指向旧文件名的链接、图片引用等路径同步更新为新的下划线命名,保持文档内部引用的完整性。
  • 纯文档变更:本次改动仅涉及文档资源(如图片、Markdown 文件)的命名与引用调整,不涉及源代码、配置或功能逻辑的任何修改。
likedislike
不准确?
atomgit-bot
atomgit-bot
7月18日 评论:

代码审查

审查结束 — 总结

审查规模

本次 diff 涉及 350 个文件,含 852 行新增、852 行删除。变更内容是:将 docs/api/ 目录下包含中英文括号的文件名/目录名替换为下划线命名(如 矩阵计算(ISASI) → cube_compute_ISASI),并同步更新所有内部交叉引用链接。

发现的问题

共报告 4 个 P1 问题(分属 3 个文件中的同一类错误),根源是相同的:在将 非连续对齐搬入(LoadAlign).md / 非连续对齐搬出(StoreAlign).md 转为英文命名时,中文字 非 被错误地前置到了新文件名 LoadAlign_continuous.md / StoreAlign_continuous.md 前面,形成了 非LoadAlign_continuous.md / 非StoreAlign_continuous.md。实际被重命名的文件是 LoadAlign_noncontinuous.md / StoreAlign_noncontinuous.md,因此这些链接全部指向不存在的位置。

优先级 数量 说明
P1 4 4 处跨 3 个文件的死链(README.md、Reg数据搬入.md、Reg数据搬出.md、基础API列表.md),根因相同

整体风险评估

中低风险。 除上述 4 处死链外,其余约 840 行的链接更新均为正确的路径替换。文件重命名干净,新增的索引文件(如 矩阵数据搬入至L1-Buffer.md 等)中的引用均指向正确的目标。建议在合并前修复这 4 处死链。

逐文件确认

对 350 个变更文件逐一审查完毕:

  • 约 300 个文件 仅为纯重命名(diff 为空),无内容风险;
  • 约 50 个文件 含内部链接更新,其中 47 个正确无误,3 个文件(Reg数据搬入.md、Reg数据搬出.md、README.md、基础API列表.md 共计 4 处链接)发现错误,均已在上方报告。
类型 数量
🔴 阻塞 12
🟡 建议 0

⛔ 需要修改

likedislike
不准确?
CANN-robotCANN-robot成员
7月18日 添加了label:cann-cla/yes
CANN-robotCANN-robot成员
7月18日 添加了label:stat/needs-squash
此处折叠了108条消息 查看更多
CANN-robotCANN-robot成员
7月20日 添加了label:ci-pipeline-passed
bianque成员
7月20日 评论:

/lgtm

likedislike
liulun0308成员
7月20日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
7月20日 添加了label:lgtmapproved
CANN-robotCANN-robot成员
7月20日 合入了pull request