Django

Code

Ticket #6119 (closed: fixed)

Opened 9 months ago

Last modified 9 months ago

request.get_host isn't documented

Reported by: SmileyChris Assigned to: PJCrosier
Milestone: Component: Documentation
Version: SVN Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

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

Attachments

6119.docs.request_response.diff (0.8 kB) - added by PJCrosier on 12/05/07 14:29:17.
Adds a short description of request.get_host() - second version

Change History

12/04/07 17:30:35 changed by PJCrosier

  • status changed from new to assigned.
  • needs_better_patch changed.
  • needs_tests changed.
  • owner changed from nobody to PJCrosier.
  • needs_docs changed.
  • has_patch set to 1.
  • 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.

12/04/07 21:05:25 changed by SmileyChris

  • needs_better_patch set to 1.

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)

12/04/07 21:06:27 changed by SmileyChris

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

12/05/07 14:29:17 changed by PJCrosier

  • attachment 6119.docs.request_response.diff added.

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

12/05/07 14:31:16 changed by PJCrosier

  • needs_better_patch deleted.

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

12/05/07 19:09:25 changed by SmileyChris

  • stage changed from Accepted to Ready for checkin.

12/17/07 06:50:07 changed by mtredinnick

  • status changed from assigned to closed.
  • resolution set to fixed.

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

Add/Change #6119 (request.get_host isn't documented)




Change Properties
Action