Opened 16 years ago
Closed 16 years ago
#6119 closed (fixed)
request.get_host isn't documented
| Reported by: | Chris Beaven | Owned by: | Pete Crosier |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Keywords: | ||
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
A while back, get_host was switched to be a method of request, but it wasn't documented.
Attachments (1)
Change History (7)
comment:1 by , 16 years ago
| Has patch: | set |
|---|---|
| Owner: | changed from to |
| Status: | new → assigned |
| Triage Stage: | Unreviewed → Accepted |
comment:2 by , 16 years ago
| 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)
by , 16 years ago
| Attachment: | 6119.docs.request_response.diff added |
|---|
Adds a short description of request.get_host() - second version
comment:4 by , 16 years ago
| 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 by , 16 years ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
comment:6 by , 16 years ago
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
(In [6941]) Fixed #6119 -- Documented HttpRequest.get_host(). Thanks, PJCrosier.
Note:
See TracTickets
for help on using tickets.
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.