已关闭
[Bug-Report|缺陷反馈]: experimental/math/acosh/docs/aclnnAcosh.md 中调用示例引用不存在的 example_aclnn_acosh.cpp #2458
gcw_93rlw6ed创建于  8月1日关闭于  8月1日
gcw_93rlw6ed
8月1日 创建

一、问题描述 (必填)

文件 experimental/math/acosh/docs/aclnnAcosh.md 第 184 行通过 inline code 引用了示例代码文件 examples/example_aclnn_acosh.cpp,但该文件在仓库中并不存在。

实际 experimental/math/acosh/examples/ 目录下的测试样例文件为 test_aclnn_acosh.cpp,并没有名为 example_aclnn_acosh.cpp 的文件。文档中的引用既使用了错误的文件名前缀(example_ 而非 test_),也导致用户无法找到正确的示例代码入口。

二、环境信息 (可选)

  • 仓库:cann/ops-math
  • 分支:master
  • 文件路径:experimental/math/acosh/docs/aclnnAcosh.md
  • 失效引用所在行:184
  • 验证方式:本地 clone master 分支后用 lsfind 验证

三、重现步骤 (可选)

  1. git clone -b master https://gitcode.com/cann/ops-math.git && cd ops-math
  2. 查看引用:sed -n '184p' experimental/math/acosh/docs/aclnnAcosh.md
    输出:完整示例代码见 \examples/example_aclnn_acosh.cpp`,以下为核心调用流程:`
  3. 验证 target 不存在:ls experimental/math/acosh/examples/example_aclnn_acosh.cpp → No such file or directory
  4. 查找 examples 实际内容:ls experimental/math/acosh/examples/ → 只有 test_aclnn_acosh.cpp
  5. 全仓搜索同名文件:find . -name "example_aclnn_acosh.cpp" → 无结果
  6. 在 GitCode Web 界面打开 experimental/math/acosh/docs/aclnnAcosh.md,第 184 行的 examples/example_aclnn_acosh.cpp 引用无法跳转到真实文件

四、预期结果 (可选)

修复 experimental/math/acosh/docs/aclnnAcosh.md 第 184 行,将失效引用替换为真实存在的样例文件:

  • 修复前:完整示例代码见 \examples/example_aclnn_acosh.cpp`,以下为核心调用流程:`
  • 修复后:完整示例代码见 \examples/test_aclnn_acosh.cpp`,以下为核心调用流程:`

五、修复建议 (可选)

该问题根因疑似 acosh 算子文档从其他算子模板复制时,未将示例文件名前缀从 example_ 更新为实际的 test_。建议:

  1. 修复本文件引用,将 example_aclnn_acosh.cpp 改为 test_aclnn_acosh.cpp
  2. 全仓扫描其他 experimental/**/docs/aclnn*.md 文件,校验 examples/ 引用是否真实存在。
  3. 可在 CI 文档检查流程中增加「代码文件引用 target 必须真实存在」的校验。

💡 备注(选填)

本 issue 与 issue #2454/#2455/#2456 属同类文档失效引用问题,建议统一在 CI 中增加引用存在性校验。

likedislike
songkai111成员
8月1日 评论:

确实存在问题,已安排相关责任人修复

likedislike
Ssongkai111成员
8月1日 关联了pull request:fix: 修复多个文档中的失效链接(#2455/#2456/#2457/#2458/#2459)
CANN-robotCANN-robot成员
8月1日 关闭了 issue
CANN-robotCANN-robot成员
8月1日 添加了label:resolved