Closed
[Documentation|文档反馈]: 修复注释与文档不一致(circular_pad、clip_by_value、coalesce_sparse) #3819
TangPCAdd on  19 days agoClosed at  18 days ago
TangPC
TangPCCollaborators
19 days ago Create

一、文档链接 (必填)

  • conversion/circular_pad/op_api/aclnn_circular_pad2d.h
  • conversion/circular_pad/op_api/aclnn_circular_pad3d.h
  • conversion/clip_by_value/examples/test_geir_clip_by_value.cpp
  • conversion/coalesce_sparse/op_kernel/coalesce_sparse.h
  • conversion/coalesce_sparse/op_kernel/coalesce_sparse_simt.h

二、问题文档片段 (必填)

  1. conversion/circular_pad/op_api/aclnn_circular_pad2d.h

    • 问题:文件末尾 #endif 的尾注释写的是 // OP_API_INC_CIRCULAR_PAD_H_,与该文件实际使用的头文件保护宏 OP_API_INC_CIRCULAR_PAD2D_H_ 不一致。
    • 修正:尾注释改为 // OP_API_INC_CIRCULAR_PAD2D_H_。
  2. conversion/circular_pad/op_api/aclnn_circular_pad3d.h

    • 问题:文件末尾 #endif 的尾注释写的是 // OP_API_INC_CIRCULAR_PAD_H_,与该文件实际使用的头文件保护宏 OP_API_INC_CIRCULAR_PAD3D_H_ 不一致。
    • 修正:尾注释改为 // OP_API_INC_CIRCULAR_PAD3D_H_。
  3. conversion/clip_by_value/examples/test_geir_clip_by_value.cpp

    • 问题:文件头 \file 注释写的是 test_geir_add_n.cpp,与实际文件名 test_geir_clip_by_value.cpp 不一致(疑似从 add_n 示例复制后未修改)。
    • 修正:\file 改为 test_geir_clip_by_value.cpp。
  4. conversion/coalesce_sparse/op_kernel/coalesce_sparse.h

    • 问题:文件末尾 #endif 的尾注释写的是 // COALESCE_SPARSE,与实际头文件保护宏 COALESCE_SPARSE_H 不一致;同时文件末尾缺少换行。
    • 修正:尾注释改为 // COALESCE_SPARSE_H,并按仓库 pre-commit 要求补文件末尾换行、应用 clang-format 规范格式(函数声明/定义换行调整,仅格式变化,不涉及逻辑)。
  5. conversion/coalesce_sparse/op_kernel/coalesce_sparse_simt.h

    • 问题:文件末尾 #endif 的尾注释写的是 // COALESCE_SPARSE_SIMT,与实际头文件保护宏 COALESCE_SPARSE_SIMT_H 不一致。
    • 修正:尾注释改为 // COALESCE_SPARSE_SIMT_H。

💡 存在的问题(选填)
上述注释与实际代码/宏定义不一致,容易在使用与维护时造成误导;本次仅修正注释与格式,不改变任何业务逻辑、接口行为或配置默认值。

关联 PR:https://gitcode.com/cann/ops-math/pull/6597

likedislike
TangPCTangPCCollaborators
19 days ago Added label: documentation
TangPC
TangPCCollaborators
19 days ago Comments:
likedislike
CANN-robotCANN-robotCollaborators
19 days ago Assign pingchuantang as responsible person
CANN-robotCANN-robotCollaborators
18 days ago Close issue
CANN-robotCANN-robotCollaborators
18 days ago Added label: resolved