已关闭
[Docs] Shape.md 三处分隔行列数与表头失配 + udf_header_files.md 一行缺第四列 #540
不喜欢雨天ༀ创建于  9 天前关闭于  9 天前
不喜欢雨天ༀ
不喜欢雨天ༀ
9 天前 创建

问题背景

两份文档存在表格结构缺陷:

docs/en/user_guides/ge_python/api/Shape.md——三张表的分隔行均多出一个空首格(\| \| :--- \| :--- \|,3 格),与表头 2 列失配:

行号 对应表
L38 Function List(表头 L37)
L48 init Parameter(表头 L47)
L54 Return Value Description(表头 L53)

GFM 规范要求分隔行列数与表头一致,不一致时整张表不被识别为表格而渲染为普通文本。

docs/zh/user_guides/dflow/dflow_api/cpp/udf_header_files_and_library_files.md——L17 Tensor类 行仅 3 格,缺第四列(其余各行均为 4 格,末列为 libflow_func.so)。

影响分析

① 在规范符合的渲染器上三张 API 表整体退化为纯文本;② 该行"动态库"列缺失。

修改建议

① 三处分隔行删去多余空首格改为 \| :--- \| :--- \|;② L17 补齐第四列 libflow_func.so

likedislike
夏国正成员
9 天前 将 Mexyy 设为负责人
夏国正成员
9 天前 评论:

您好,您提出的问题确实存在,我们将尽快提出pr并关联issue进行修复。

likedislike
夏国正成员
9 天前 将 sophia1213 设为负责人
Sophia1213Sophia1213成员
9 天前 关联了pull request:【PR】: 更新资料中的链接
CANN-robotCANN-robot成员
9 天前 关闭了 issue
CANN-robotCANN-robot成员
9 天前 添加了label:resolved