Opened 16 years ago

Closed 16 years ago

Last modified 16 years ago

#7216 closed (fixed)

Permalink documentation is missing mention of named URL pattern

Reported by: Masklinn Owned by: nobody
Component: Documentation Version: dev
Severity: Keywords:
Cc: masklinn@… 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

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 (2)

permalink_doc.diff (1.3 KB ) - added by Masklinn 16 years ago.
permalink_doc_filled.diff (1.3 KB ) - added by Masklinn 16 years ago.
patch with line breaks according to style guide

Download all attachments as: .zip

Change History (6)

by Masklinn, 16 years ago

Attachment: permalink_doc.diff added

by Masklinn, 16 years ago

Attachment: permalink_doc_filled.diff added

patch with line breaks according to style guide

comment:1 by Simon Greenhill, 16 years ago

Triage Stage: UnreviewedReady for checkin

comment:2 by Simon Greenhill, 16 years ago

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

comment:3 by Russell Keith-Magee, 16 years ago

Resolution: fixed
Status: newclosed

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

comment:4 by Gary Wilson, 16 years ago

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

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