python / python/cpython

HTTP modules documentation displays a list of both unsupported http and supported codes, contrary to caption.

未关闭
#135,615 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

docs
主要语言
Python
星标
77.2k
派生
35.9k
PR 合并指标
PR 指标待抓取

描述

Documentation

The HTTP module supports status codes that are unregistered/unofficial. Take http status code 418: I'm a teapot Due to the save418 movement (https://save418.com/), python decided to preserve http code 418 in its codebase, but this documentation contradicts itself.

However, in the documentation, right above the table of status codes supported by the http library we have this:

Supported, IANA-registered status codes available in http.HTTPStatus are:

This is factually incorrect, because code 418, (among others) is not official, and this should either be edited to say:

"Supported Status Codes Available in http.httpStatus are:" or list exceptions.

Linked PRs
  • gh-135625

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 HTTP 模块文档中状态码表格上方的段落开始,将其说明与列出的代码进行比较,包括 418。更新措辞,使其准确描述受支持的代码,然后验证渲染后的文档;关联的 PR gh-135625 表明这项工作已经在进行中。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
描述清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。