Code

Opened 6 years ago

Closed 6 years ago

#6119 closed (fixed)

request.get_host isn't documented

Reported by: SmileyChris Owned by: PJCrosier
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 PJCrosier 6 years ago.
Adds a short description of request.get_host() - second version

Download all attachments as: .zip

Change History (7)

comment:1 Changed 6 years ago by PJCrosier

  • Has patch set
  • Needs documentation unset
  • Needs tests unset
  • Owner changed from nobody to PJCrosier
  • Patch needs improvement unset
  • Status changed from new to assigned
  • Triage Stage changed from Unreviewed to Accepted

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 6 years ago by SmileyChris

  • 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 6 years ago by SmileyChris

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

Changed 6 years ago by PJCrosier

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

comment:4 Changed 6 years ago by PJCrosier

  • 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 6 years ago by SmileyChris

  • Triage Stage changed from Accepted to Ready for checkin

comment:6 Changed 6 years ago by mtredinnick

  • Resolution set to fixed
  • Status changed from assigned to closed

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

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.