Merged
统一C API文档格式 #6641
统一C API文档格式 #6641
Merged
GRJ_XIDUOAdd on 28 days ago
GRJ_XIDUO
GRJ_XIDUOCollaborators
28 days ago

描述

统一docs/zh/api/SIMD-API/c_api下多类文档格式问题,降低同类接口页面之间的格式差异。

主要改动:

  • 统一表题格式,修正“表”和序号之间的空格问题。
  • 统一函数原型代码块格式,补充和规范函数原型典型示例。
  • 统一dtype支持数据类型小节标题、标题层级和正文格式。
  • 删除冗余的“模板原型”标题,并同步调整下级标题层级。
  • 清理C API文档中多余空行。
  • 将“占位符形式”说明从标题移动到函数原型注释中,并补充缺失的占位符说明。

关联的Issue

无

测试

已执行:

  • git diff --check
  • 全量搜索确认标题中不再包含不应出现的“占位符形式”
  • 对目标文件进行结构化复查,确认函数原型典型示例、占位符说明和占位符注释补充完整
  • 多次针对docs/zh/api/SIMD-API/c_api执行格式一致性搜索复查

文档更新

更新了docs/zh/api/SIMD-API/c_api下C API相关Markdown文档。

类型标签

likedislike
Pull Request has been successfully merged by CANN-robot.
(Thank you for GRJ_XIDUO's contribution.)
GRJ_XIDUOGRJ_XIDUOCollaborators
28 days ago Created pull request, commit db346a80
GRJ_XIDUOGRJ_XIDUOCollaborators
28 days ago Associated issue: [Documentation|文档反馈]: IBSet 的约束描述不清晰
atomgit-bot
atomgit-bot
28 days ago Comments:

变更摘要

本次变更为文档格式统一类改动,目标是降低 docs/zh/api/SIMD-API/c_api 目录下同类 C API 页面之间的格式差异,使表题、函数原型代码块、dtype 支持数据类型小节以及标题层级在各文档间保持一致。改动不涉及接口行为、数据结构或配置语义变化,主要是表述与排版层面的规范化。

主要改动

  • 统一表题格式: 规范各文档中表题“表”与序号之间的空格写法,消除同类页面间的表题格式不一致。
  • 统一函数原型代码块格式: 规范函数原型代码块的书写形式,并补充、统一函数原型的典型示例。
  • 统一 dtype 支持数据类型小节: 统一该小节的标题文本、标题层级与正文格式,使不同接口页面结构对齐。
  • 删除冗余“模板原型”标题并调整层级: 移除多余的“模板原型”标题,并同步下移其下级标题层级。
  • 调整“占位符形式”说明位置: 将该说明从标题移至函数原型注释中,并补充缺失的占位符说明,同时清理文档中的多余空行。
likedislike
Incorrect?
atomgit-bot
atomgit-bot
28 days ago Comments:

🤖 本次改动均为数据 / 生成 / 二进制文件(如测试用例、锁文件、媒体资源),没有可审查的代码逻辑,已跳过 AI 代码审查。

likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
28 days ago Added label: stat/needs-squash
76 messages are collapsed here。 See more
munanhwCollaborators
26 days ago Comments:

/approve

likedislike
CANN-robotCANN-robotCollaborators
26 days ago Added label: approved
LycheeeeeCollaborators
26 days ago Comments:

/lgtm

likedislike
CANN-robotCANN-robotCollaborators
26 days ago Added label: lgtm
CANN-robotCANN-robotCollaborators
26 days ago Merged pull request