Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#7216 closed (fixed)

Permalink documentation is missing mention of named URL pattern

Reported by: masklinn Owned by: nobody
Component: Documentation Version: master
Severity: Keywords:
Cc: masklinn@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

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 7 years ago.
permalink_doc_filled.diff (1.3 KB) - added by masklinn 7 years ago.
patch with line breaks according to style guide

Download all attachments as: .zip

Change History (6)

Changed 7 years ago by masklinn

Changed 7 years ago by masklinn

patch with line breaks according to style guide

comment:1 Changed 7 years ago by Simon Greenhill

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Ready for checkin

comment:2 Changed 7 years ago by Simon Greenhill

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

comment:3 Changed 7 years ago by russellm

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

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

comment:4 Changed 7 years ago by gwilson

(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