Prhub

#35530 [Misc] Fix stale doc URL and docstring module path

原始 PR 作者 umut-polat 合并时间 2026-06-21 07:57 文件变更 2 提交数 3 评论 2 代码增减 +2 / -2

执行摘要

修复两处过时文档引用

PR 提交者发现两个文档引用已过时:VLLM_PORT 错误信息链接到 en/stable/serving/env_vars.html 返回 404,应指向 en/latest/configuration/env_vars.html;tool_parsers/init.py 的 docstring 示例中模块路径写的是 vllm.tool_parsers.kimi_k2_parser,但实际模块名为 kimi_k2_tool_parser。

PR 改动简单明确,无功能影响,值得合并以改善文档准确性。不建议精读。

讨论亮点

无 review 讨论。gemini-code-assist[bot] 的自动评论确认了改动的准确性,sfeng33 直接批准并回复 "Thanks"。

实现拆解

  1. 在 vllm/envs.py 中,将 get_vllm_port() 函数内 ValueError 的提示 URL 从 https://docs.vllm.ai/en/stable/serving/env_vars.html 更新为 https://docs.vllm.ai/en/latest/configuration/env_vars.html,避免用户跳转到 404 页面。
  2. 在 vllm/tool_parsers/init.py 中,将 docstring 示例里的 module_path="vllm.tool_parsers.kimi_k2_parser" 修正为 module_path="vllm.tool_parsers.kimi_k2_tool_parser",使示例与实际模块名称一致。
文件 模块 状态 重要度
vllm/envs.py 环境配置 modified 3.83
vllm/tool_parsers/__init__.py 工具解析器 modified 4.03

关键符号

get_vllm_port

关键源码片段

vllm/envs.py core-logic

修复 VLLM_PORT 错误信息中的文档 URL,避免用户访问 404 页面。

def get_vllm_port() -> int | None:
    """Get the port from VLLM_PORT environment variable."""
    if "VLLM_PORT" not in os.environ:
        return None
    port = os.getenv("VLLM_PORT", "0")
    try:
        return int(port)
    except ValueError as err:
        from urllib3.util import parse_url
        parsed = parse_url(port)
        if parsed.scheme:
            raise ValueError(
                f"VLLM_PORT '{port}' appears to be a URI. "
                "This may be caused by a Kubernetes service discovery issue,"
                "check the warning in: https://docs.vllm.ai/en/latest/configuration/env_vars.html"
                # 原 URL 为 en/stable/serving/env_vars.html(返回 404),
                # 已更新为 en/latest/configuration/env_vars.html
            ) from None
        raise ValueError(f"VLLM_PORT '{port}' must be a valid integer") from err

评论区精华

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

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

风险与影响

无技术风险。两个改动均为纯文档/字符串更正,不涉及逻辑变更。

影响范围极小。仅影响:

1) VLLM_PORT 设置错误时用户的错误提示链接(从 404 变为有效页面);
2) tool_parsers 模块文档字符串中示例代码的准确性。对系统行为、性能、安全性等均无影响。

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论