执行摘要
移除配置类 docstring 中的显式换行符,优化 CLI 帮助文本格式化。
PR body 引用 https://github.com/vllm-project/vllm/pull/38125#issuecomment-4135416267 的建议(具体评论内容未提供),旨在改进 --help 格式化,减少手动添加换行符的需求。动机是使 docstring 中的列表项在 CLI 帮助中正确显示,无需依赖显式 \n。
对于负责 CLI 或文档维护的开发者,建议阅读此 PR 以了解如何自动处理 docstring 列表格式化。重点关注 SortedHelpFormatter._split_lines 方法中的 regex 设计,它展示了处理 Markdown 风格列表的实用技巧,值得学习。
review 中核心讨论来自 gemini-code-assist[bot],它指出初始 regex 未处理有序列表(如 '1.'),建议扩展以支持数字加点开头的行,防止格式化错误。作者 hmellor 回应 'Sure, why not' 并在第二个 commit 中更新 regex,解决了这一设计问题。没有其他争议,PR 获得多个批准(如 mtsokol、DarkLight1337)。
参与讨论