Merged
修复 ops-nn QUICKSTART.md 文档扫描问题(11处) #14314
liujing987913Add on 9 days ago
修复 ops-nn QUICKSTART.md 文档扫描问题(11处) #14314
Merged
liujing987913Add on 9 days ago
liujing987913
liujing987913Collaborators
9 days ago

描述

  • 背景:AIDD/文档质量扫描发现 ops-nn 仓 docs/QUICKSTART.md 文档问题 11 处
  • 修改分类:代码块语言标签 1、参数名/括号 1、行内代码标记 1、引导句标点 3、漏字 1、术语大小写 3(Kernel/Tensor/Host+Vector)
  • 涉及文件:docs/QUICKSTART.md(1 个文件,11 处)
  • 验证:git diff 确认为纯文本修改,无代码内容误改;已人工核对

关联的Issue

https://gitcode.com/cann/ops-nn/issues/8705

测试

文档更新

本次 PR 更新 ops-nn docs/QUICKSTART.md,修正标点/术语/行内代码格式问题 11 处,详见 diff。

类型标签

  • 文档更新
likedislike
Pull Request has been successfully merged by CANN-robot.
(Thank you for liujing987913's contribution.)
liujing987913liujing987913Collaborators
9 days ago Created pull request, commit b8335e11
liujing987913liujing987913Collaborators
9 days ago Associated issue: [Documentation|文档反馈]: 修复 ops-nn QUICKSTART.md 文档扫描问题(11处)
atomgit-bot
atomgit-bot
9 days ago Comments:

变更摘要

本 PR 针对文档质量扫描发现的 docs/QUICKSTART.md 问题,完成 11 处纯文本修正,覆盖代码块语言标签、行内代码标记、参数名与括号、引导句标点、术语大小写及表述补全。改动不涉及任何代码逻辑、构建脚本或配置项,仅提升文档的格式规范性与术语一致性。

主要改动

  • 代码块语言标签修正:编译成功提示的输出示例代码块由 bash 改为 output,避免把命令输出误标为可执行脚本。
  • 行内代码标记规范:将 ${ASCEND_HOME_PATH}/opp/vendors 与 ${ASCEND_HOME_PATH} 外层的三反引号改为单反引号,使其作为行内代码正确渲染。
  • 引导句标点统一:${soc_version} 取值说明与“若提示如下信息,说明编译成功”两处引导句由句号改为冒号,与后续列表/示例形成承接关系。
  • 参数名与括号修正:--vendor_name(可选) 中的半角括号改为全角括号,并把说明文字中的 vendorname 更正为 vendor_name,与参数名保持一致。
  • 术语大小写统一:kernel、tensor、host侧数据vector 分别统一为 Kernel、Tensor、Host侧数据Vector;同时将环境变量段落补为“确保运行时能够找到对应库文件”,使表述完整。

🧩 本次 Review 已使用自定义 Skill:

likedislike
Incorrect?
atomgit-bot
atomgit-bot
9 days ago Comments:

代码审查

✅ 未发现问题


🧩 本次 Review 已使用自定义 Skill:

likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
9 days ago Added label: cann-cla/yes
CANN-robot
CANN-robotCollaborators
9 days ago Comments:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here.
You can get sig-info at here.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.


PR Approval Progress

✅ Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
docs ✅ 冯英, 陈琦 (2/2) ✅ 冯英 (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

liujing987913, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robotCANN-robotCollaborators
9 days ago Set zengjuan,chaotang233,crystalhu,yangyang016,fanqirui,gitee-duhuiping,chenqi317,liubo75,tangweiwei2,gitcode-chenjiao,lwx1255555,pingchuantang,fengying555682,caiwenwen,yanglu-1 as approver
CANN-robotCANN-robotCollaborators
9 days ago Set gitee-duhuiping,gitcode-chenjiao,lwx1255555,fengying555682,caiwenwen,yanglu-1 as approver
liujing987913
liujing987913Collaborators
9 days ago Comments:

compile

likedislike
liujing987913liujing987913Collaborators
9 days ago Pre merge succeeded (commit_id: 2074a6b40b126a01b190f1ff13ceb4367cf4c6ad)
CANN-robot
CANN-robotCollaborators
9 days ago Comments:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robotCollaborators
9 days ago Added label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
9 days ago Removed label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
9 days ago Added label: ci-pipeline-passed
fengying555682
fengying555682Collaborators
9 days ago Comments:

/lgtm
/approve

likedislike
CANN-robotCANN-robotCollaborators
9 days ago Added label: approved
chenqi317
chenqi317Collaborators
9 days ago Comments:

/lgtm
/approve

likedislike
CANN-robot
CANN-robotCollaborators
9 days ago Comments:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
/approve: 陈琦

likedislike
CANN-robotCANN-robotCollaborators
9 days ago Added label: lgtm
CANN-robotCANN-robotCollaborators
9 days ago Merged pull request
yuning_chen
yuning_chenCollaborators
9 days ago Comments:

您好,pr合入已准备就绪,请尽快联系committer进行检视,谢谢!
@fengying555682 @lwx1255555 @pingchuantang @yangyang016 @yanglu-1

likedislike