已关闭
[Documentation|文档反馈]: 修复SIMD C API文档语病、错别字、标点误用等问题 #1879
GRJ_XIDUO创建于  14 天前关闭于  14 天前
GRJ_XIDUO
GRJ_XIDUO成员
14 天前 创建

Document Link(文档链接)

docs/zh/api/SIMD-API/c_api

Issues Section(问题文档片段)

涉及以下文档片段:

序号 文件 行号 问题类型 问题说明
1 docs/zh/api/SIMD-API/c_api/sync/intra_core_sync/asc_sync_mte3.md 111 词语重复 需分别分别编写notify与wait 中 分别 重复。
2 docs/zh/api/SIMD-API/c_api/cube_compute/cube_compute_fractal_intro/aux_cube_fractal_format_details.md 82 错别字、标点误用 密化过程中 表述错误;矩阵。,对于 存在多余标点。
3 docs/zh/api/SIMD-API/c_api/vector_compute/vector_reduce/asc_reduce.md 63 错别字 取第四个元素 误写为 区第四个元素。
4 docs/zh/api/SIMD-API/c_api/vector_compute/vector_permute_sel/asc_transto5hd.md 75 标点空格 , repeat 中逗号后存在多余空格。
5 docs/zh/api/SIMD-API/c_api/deprecated_interface/asc_transto5hd_sync_deprecated.md 68 标点空格 , repeat 中逗号后存在多余空格。
6 docs/zh/api/SIMD-API/c_api/vector_compute/vector_permute_sel/asc_transto5hd.md 78-79 语病、标点误用 该配置只配置int8_t/uint8_t的数据类型 表述不通顺;true:表示、false:表示 使用英文冒号。
7 docs/zh/api/SIMD-API/c_api/deprecated_interface/asc_transto5hd_sync_deprecated.md 71-72 语病、标点误用 废弃接口文档存在与 asc_transto5hd.md 相同的表述和标点问题。
8 docs/zh/api/SIMD-API/c_api/vector_compute/vector_convert/asc_float2float.md 32 标点误用 中文句子中使用英文逗号。
9 docs/zh/api/SIMD-API/c_api/deprecated_interface/asc_float2float_sync_deprecated.md 33 标点误用 中文句子中使用英文逗号。
10 docs/zh/api/SIMD-API/c_api/utils/sys_var/asc_get_arch_ver.md 68 标点误用 core_version,调用 中使用英文逗号。
11 docs/zh/api/SIMD-API/c_api/cube_datamove/cube_compute_store/asc_copy_l0c2gm_arch_2201.md 70 复制错误 n_size 参数说明误写为 m_size的取值范围。
12 docs/zh/api/SIMD-API/c_api/deprecated_interface/asc_copy_l0c2gm_sync_arch_2201_deprecated.md 68 复制错误 废弃接口文档中 n_size 参数说明误写为 m_size。
13 docs/zh/api/SIMD-API/c_api/cube_datamove/cube_compute_store/asc_copy_l0c2gm_arch_2201.md 72 标点误用 中文句子中使用英文逗号;取值不为0 , 存在多余空格。
14 docs/zh/api/SIMD-API/c_api/deprecated_interface/asc_copy_l0c2gm_sync_arch_2201_deprecated.md 70 标点误用 废弃接口文档中存在英文逗号和多余空格。
15 docs/zh/api/SIMD-API/c_api/cube_datamove/cube_compute_store/asc_copy_l0c2l1_arch_2201.md 74 标点空格 取值不为0 , 存在多余空格。
16 docs/zh/api/SIMD-API/c_api/deprecated_interface/asc_copy_l0c2l1_sync_arch_2201_deprecated.md 72 标点空格 废弃接口文档中存在 取值不为0 , 多余空格。
17 docs/zh/api/SIMD-API/c_api/cube_datamove/cube_compute_store/asc_copy_l0c2l1_arch_3510.md 135-136 标点空格、断句 •对于 缺少空格;单位:element对于 断句不当。
18 docs/zh/api/SIMD-API/c_api/cube_datamove/cube_compute_store/asc_copy_l0c2ub.md 140 断句 单位为元素。对于不同... 断句不自然。
19 docs/zh/api/SIMD-API/c_api/deprecated_interface/asc_copy_l0c2ub_deprecated.md 176 断句 废弃接口文档中存在与 asc_copy_l0c2ub.md 相同的断句问题。
20 docs/zh/api/SIMD-API/c_api/cube_datamove/cube_compute_store/asc_copy_l0c2gm_arch_3510.md 43-44 标点误用 列表项结尾使用英文分号。
21 docs/zh/api/SIMD-API/c_api/cube_datamove/cube_compute_store/asc_copy_l0c2l1_arch_3510.md 43-44 标点误用 列表项结尾使用英文分号。
22 docs/zh/api/SIMD-API/c_api/cube_datamove/cube_compute_store/asc_copy_l0c2ub.md 43-44 标点误用 列表项结尾使用英文分号。
23 docs/zh/api/SIMD-API/c_api/deprecated_interface/asc_copy_l0c2gm_deprecated.md 45-46 标点误用 废弃接口文档列表项结尾使用英文分号。
24 docs/zh/api/SIMD-API/c_api/deprecated_interface/asc_copy_l0c2ub_deprecated.md 45-46 标点误用 废弃接口文档列表项结尾使用英文分号。
25 docs/zh/api/SIMD-API/c_api/deprecated_interface/asc_bfloat162e1m2x2_deprecated.md 42-80 标点误用 函数原型注释中多处 舍入模式,数据写入... 使用英文逗号。

Existing Issues(存在的问题)

docs/zh/api/SIMD-API/c_api 目录下存在一批明确的语病、错别字、标点误用和复制错误,包括词语重复、中文语句中误用英文标点、标点后多余空格、参数说明复制错误和断句不当等问题。该问题不包含占位符说明、函数原型示例等结构类规范问题。

建议按上述文件清单逐项修复,并在修复后执行低级问题正则复扫及 git diff --check -- docs/zh/api/SIMD-API/c_api 检查。

likedislike
GRJ_XIDUOGRJ_XIDUO成员
14 天前 添加了label:documentation
GRJ_XIDUOGRJ_XIDUO成员
14 天前 将 GRJ_XIDUO 设为负责人
GRJ_XIDUOGRJ_XIDUO成员
14 天前 修改了issue 的描述
GRJ_XIDUO
GRJ_XIDUO成员
14 天前 评论:

您好,反馈的一系列资料问题已确认,将在10月15日完成修复。

likedislike
GRJ_XIDUOGRJ_XIDUO成员
14 天前 修改标题为 “[Documentation|文档反馈]: 修复SIMD C API文档语病、错别字、标点误用等问题”,原标题为“[Documentation|文档反馈]: 修复SIMD C API文档低级文字问题”
GRJ_XIDUO
GRJ_XIDUO成员
14 天前 评论:

您好,修复问题的PR已合入:
https://gitcode.com/cann/asc-devkit/pull/6590

likedislike
GRJ_XIDUOGRJ_XIDUO成员
14 天前 issue状态由 进行中 改变为 已完成
GRJ_XIDUOGRJ_XIDUO成员
14 天前 关闭了 issue
CANN-robotCANN-robot成员
14 天前 添加了label:resolved