Document parse_headers function of http.client

[orsenthil]

BPO	21257
Nosy	@orsenthil, @briancurtin, @berkerpeksag, @vadmium, @demianbrecht, @iritkatriel
PRs	bpo-21257: document http.client.parse_headers #11443 bpo-21257: document http.client.parse_headers #11443 bpo-21257: document http.client.parse_headers #11443 bpo-21257: document http.client.parse_headers #11443

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/orsenthil'
closed_at = <Date 2020-10-20.10:21:34.374>
created_at = <Date 2014-04-16.16:44:59.442>
labels = ['easy', 'type-feature', 'docs']
title = 'Document parse_headers function of http.client'
updated_at = <Date 2020-10-20.10:21:34.373>
user = 'https://github.com/orsenthil'

bugs.python.org fields:

activity = <Date 2020-10-20.10:21:34.373>
actor = 'iritkatriel'
assignee = 'orsenthil'
closed = True
closed_date = <Date 2020-10-20.10:21:34.374>
closer = 'iritkatriel'
components = ['Documentation']
creation = <Date 2014-04-16.16:44:59.442>
creator = 'orsenthil'
dependencies = []
files = []
hgrepos = []
issue_num = 21257
keywords = ['patch', 'patch', 'patch', 'patch', 'easy']
message_count = 9.0
messages = ['216494', '236014', '236183', '236227', '236235', '236271', '236298', '333983', '378277']
nosy_count = 6.0
nosy_names = ['orsenthil', 'brian.curtin', 'berker.peksag', 'martin.panter', 'demian.brecht', 'iritkatriel']
pr_nums = ['11443', '11443', '11443', '11443']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue21257'
versions = ['Python 3.4', 'Python 3.5']

[orsenthil]

It is undocumented. While fixing a doc issue bpo-18229 for http.server I noticed that I referenced that function and when I looked up for the documentation, it was lacking.

[vadmium]

See also bpo-23439, about updating __all__ (or not updating __all__, as it seems to be turning into)

[demianbrecht]

Left a super minor comment in Rietveld, but otherwise LGTM.

[demianbrecht]

Ignore my previous comment. It was intended for bpo-23439.

[demianbrecht]

And this really should likely now be closed as a duplicate of bpo-23439.

[berkerpeksag]

This is a different issue than bpo-23439. BaseHTTPRequestHandler.headers documentation mentions about parse_headers function, the function itself is not documented. See https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.headers

[demianbrecht]

On Feb 20, 2015, at 3:10 AM, Berker Peksag <report@bugs.python.org> wrote:
This is a different issue than bpo-23439. BaseHTTPRequestHandler.headers documentation mentions about parse_headers function, the function itself is not documented.

Not entirely sure what I was thinking here. I was under the impression that the docs for parse_headers had been added in the linked issue. Thanks for pointing that out.

[briancurtin]

New changeset 478f829 by Brian Curtin (Ashwin Ramaswami) in branch 'master':
bpo-21257: document http.client.parse_headers (GH-11443)
478f829

[iritkatriel]

This seems complete. Can it be closed?