Opened 9 years ago

Closed 9 years ago

#6119 closed (fixed)

request.get_host isn't documented

Reported by: Chris Beaven Owned by: Pete Crosier
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

A while back, get_host was switched to be a method of request, but it wasn't documented.

Attachments (1)

6119.docs.request_response.diff (806 bytes) - added by Pete Crosier 9 years ago.
Adds a short description of request.get_host() - second version

Download all attachments as: .zip

Change History (7)

comment:1 Changed 9 years ago by Pete Crosier

Has patch: set
Needs documentation: unset
Needs tests: unset
Owner: changed from nobody to Pete Crosier
Patch needs improvement: unset
Status: newassigned
Triage Stage: UnreviewedAccepted

I've added a small patch for the documentation, mainly based on the docstrings.. hopefully the markup is fine? I was unsure how to test how it would render.

comment:2 Changed 9 years ago by Chris Beaven

Patch needs improvement: set

Looks good PJ, I can see a small problem with the format (you're using `PEP333`_ then {{.. _PEP 333:}})

A nice way to check your docs is to use my django-documentation package (you'll just need to change the new documentation template to render it's variables with |safe, haven't had time to put a new version up)

comment:3 Changed 9 years ago by Chris Beaven

`PEP333`_ (without a space) then .. _`PEP 333`: (with a space)

Changed 9 years ago by Pete Crosier

Adds a short description of request.get_host() - second version

comment:4 Changed 9 years ago by Pete Crosier

Patch needs improvement: unset

Thanks Chris, django-documentation was very handy. The link's now working and I've added the obligatory 'New in Django..' message.

comment:5 Changed 9 years ago by Chris Beaven

Triage Stage: AcceptedReady for checkin

comment:6 Changed 9 years ago by Malcolm Tredinnick

Resolution: fixed
Status: assignedclosed

(In [6941]) Fixed #6119 -- Documented HttpRequest.get_host(). Thanks, PJCrosier.

Note: See TracTickets for help on using tickets.
Back to Top