Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document parse_headers function of http.client #65456

Closed
orsenthil opened this issue Apr 16, 2014 · 9 comments
Closed

Document parse_headers function of http.client #65456

orsenthil opened this issue Apr 16, 2014 · 9 comments
Assignees
@orsenthil
Labels
docs Documentation in the Doc dir easy type-feature A feature request or enhancement

Comments

@orsenthil
Copy link
Member

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
    Copy link
    Member Author

    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.

    @orsenthil orsenthil added the type-bug An unexpected behavior, bug, or error label Apr 16, 2014
    @orsenthil orsenthil self-assigned this Apr 16, 2014
    @vadmium
    Copy link
    Member

    vadmium commented Feb 15, 2015

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

    @demianbrecht
    Copy link
    Mannequin

    demianbrecht mannequin commented Feb 18, 2015

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

    @demianbrecht
    Copy link
    Mannequin

    demianbrecht mannequin commented Feb 19, 2015

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

    @demianbrecht
    Copy link
    Mannequin

    demianbrecht mannequin commented Feb 19, 2015

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

    @berkerpeksag
    Copy link
    Member

    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

    @berkerpeksag berkerpeksag added easy docs Documentation in the Doc dir type-feature A feature request or enhancement and removed type-bug An unexpected behavior, bug, or error labels Feb 20, 2015
    @demianbrecht
    Copy link
    Mannequin

    demianbrecht mannequin commented Feb 20, 2015

    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
    Copy link
    Member

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

    @iritkatriel
    Copy link
    Member

    This seems complete. Can it be closed?

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @orsenthil orsenthil

    Labels
    docs Documentation in the Doc dir easy type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    5 participants
    @berkerpeksag @orsenthil @briancurtin @vadmium @iritkatriel