Prhub

#7093 [doc] chore: ascend doc, fix typos, punctuation, broken links and code errors

原始 PR 作者 hustmf 合并时间 2026-07-20 00:40 文件变更 24 提交数 1 评论 3 代码增减 +130 / -130

执行摘要

修复 Ascend 教程文档中 132 个拼写、链接和代码错误

根据 PR body,开发者在 Ascend 教程文档中确认了 132 个问题,涵盖拼写、术语、代码/配置错误、链接、中文标点、格式等,需统一修复以提升文档质量与准确性。

常规文档维护 PR,建议快速查阅以了解常见文档错误类型。重点关注 review 中提出的废弃配置引用问题,后续应由单独 PR 清理。

讨论亮点

Review 中 gemini-code-assist[bot] 指出文档仍引用了已废弃的 use_mbridgevanilla_mbridge 配置选项,并建议移除。该问题未在当前 PR 中修复,但 PR 仍被 wucong25 合并。无其他讨论。

实现拆解

  1. 拼写与术语错误修复:修正 ascned→ascend、toke→token、DockerFile→Dockerfile、Verl→VeRL 等常见错误。
  2. 代码/配置错误纠正:将 NPU 设备列表从 0-8 改为 0-7;补全缺失的 Python 冒号;修正 --local-dir 用法;移除多余的换行与空格。
  3. 链接修复:替换 404 链接;将 http 升级为 https;移除 URL 中的零宽字符;更新失效的参考链接。
  4. 中文标点与格式规范化:统一全角/半角标点;补充缺失的句号;调整 RST 标题层级(如 #########);修正 Markdown 代码块语言标签(如 ```→bash`)。
  5. 文件重命名:将 ascend_retool_best_pratice.rst 重命名为 ascend_retool_best_practice.rst,修正拼写错误。
    所有变更均为纯文档操作,不涉及代码逻辑改动,测试与配置无配套变更。
文件 模块 状态 重要度
docs/ascend_tutorial/model_support/examples/ascend_retool_best_practice.rst 教程文档 renamed 3.82
docs/ascend_tutorial/model_support/examples/dapo_multi_model_optimization_practice.md 教程文档 modified 3.58
docs/ascend_tutorial/feature_support/ascend_backend_features.md 教程文档 modified 3.49
docs/ascend_tutorial/dev_guide/model_dev/transfer_to_npu_guide.md 教程文档 modified 3.19
docs/ascend_tutorial/model_support/examples/gspo_optimization_practice.md 教程文档 modified 3.21

关键符号

Patch parse_path

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

废弃配置 use_mbridge 和 vanilla_mbridge 的引用 documentation

gemini-code-assist[bot] 在 transfer_to_npu_guide.md 和 ascend_backend_features.md 中评论,指出 use_mbridge 和 vanilla_mbridge 已废弃,不应在文档中出现。

结论:问题未在当前 PR 修复,但 PR 仍被批准合并。需后续单独跟进清理。 · 已解决

风险与影响

风险极低,仅涉及文档内容修正。但文档中保留了已废弃的 use_mbridge/vanilla_mbridge 配置引用,可能误导用户继续使用这些即将被移除的选项。建议后续单独跟进清理。

对用户阅读 Ascend 教程文档有正面影响,减少因拼写、链接错误导致的困惑。对系统运行无影响。

文档引用已废弃配置

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论