Prhub

#49781 [Docs] Fix confusing docstring indentation in nemotron_h.py

原始 PR 作者 Johnny-Liou 合并时间 2026-07-25 15:33 文件变更 1 提交数 1 评论 1 代码增减 +1 / -2

执行摘要

修复 nemotron_h.py docstring 缩进警告

PR #48018 添加的 docstring 在 main 分支上触发 griffe 警告:Confusing indentation for continuation line 11 in docstring, should be 4 * 2 = 8 spaces, not 6,由于 .readthedocs.yaml 设置了 fail_on_warning: true,该警告直接导致 RTD 构建失败(RTD 33746915 on 866fea2b9)。此 PR 旨在消除该构建失败。

该 PR 为纯文档修复,价值在于确保 CI 文档构建通过。可快速合并,无需深入审查。建议关注作者测试方案中使用的 --strict 构建模式,该模式可推广至其他文档 PR 以提前发现类似问题。

讨论亮点

无实质性讨论。review 均为自动批准,仅 mergify[bot] 提示 pre-commit 失败,但作者后续提交已通过。

实现拆解

get_mamba_state_shape_from_config 方法 docstring 中挂起 bullet 的缩进从 6 空格调整为 8 空格,并将多行描述合并为一行。具体变更:
- 原写法:

- (when use_replayssm is enabled) the x_cache/dt_cache/B_cache
  ring-buffer shapes

- 新写法:
- x_cache/dt_cache/B_cache ring-buffer shapes (use_replayssm only)

这样 bullet 内容全部位于与 bullet 标记对齐的同一行(即缩进 4 空格),无续行,完全符合 griffe 的缩进要求。

文件 模块 状态 重要度
vllm/model_executor/models/nemotron_h.py 文档 modified 4.2

关键符号

get_mamba_state_shape_from_config

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

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

仅 docstring 文本变更,无运行时影响。风险极低。

影响范围仅限于 nemotron_h.py 的 docstring 视觉效果和文档构建。修复后 RTD 构建不再因该警告而失败。对用户无直接功能影响。

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论