Django

Code

Ticket #7216 (closed: fixed)

Opened 2 months ago

Last modified 3 weeks ago

Permalink documentation is missing mention of named URL pattern

Reported by: masklinn Assigned to: nobody
Milestone: Component: Documentation
Version: SVN Keywords:
Cc: masklinn@masklinn.net Triage Stage: Ready for checkin
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

Although named URL patterns are documented in the URL Dispatch documentation, they are not mentioned in the documentation for permalink in the Model API documentation, nor is the url dispatch documentation linked.

This drastically lowers their discoverability of that feature (more django users would go through all of the model api page than through the URL dispatch documentation).

Either a basic documentation of named URL patterns should be added to that of permalink, or a mention of them and a link to the URL dispatch documentation should be added.

The provided patch is a tentative to accomplish the former.

Attachments

permalink_doc.diff (1.3 kB) - added by masklinn on 05/11/08 15:19:30.
permalink_doc_filled.diff (1.3 kB) - added by masklinn on 05/14/08 09:23:22.
patch with line breaks according to style guide

Change History

05/11/08 15:19:30 changed by masklinn

  • attachment permalink_doc.diff added.

05/14/08 09:23:22 changed by masklinn

  • attachment permalink_doc_filled.diff added.

patch with line breaks according to style guide

06/14/08 02:13:07 changed by Simon Greenhill

  • needs_better_patch changed.
  • stage changed from Unreviewed to Ready for checkin.
  • needs_tests changed.
  • needs_docs changed.

06/14/08 07:27:21 changed by Simon Greenhill

#7003 was marked as a duplicate, and contains an alternative patch.

06/17/08 08:56:10 changed by russellm

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

(In [7678]) Fixed #7216 -- Added a description on how to use named URLs with a permalink. Thanks, masklinn.

06/17/08 10:47:00 changed by gwilson

(In [7681]) Refs #7216 -- Corrected typo, removed comma, trimmed trailing whitespace, and fixed reST link in [7678].

Add/Change #7216 (Permalink documentation is missing mention of named URL pattern)




Change Properties
Action