Code

Opened 7 years ago

Closed 7 years ago

#4302 closed (fixed)

Fix usage of "absolute URL" in the documentation

Reported by: mtredinnick Owned by: nobody
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Django's documentation is using the term "absolute URL" in a way that is inconsistent with existing standards. We should fix that; it leads to errors too easily.

The relevant definition to apply is in section 3 (and also section 1.4) of RFC 2396: An absolute URI includes everything from the scheme ("http:", etc) onwards. All other URIs are relative.

Documentation that needs to be updated

  • get_absolute_url() -- all our examples are relative and absolute URLs are in the sites documentation. Add a link between the two and some explanation.
  • The location field in sitemaps.
  • A few places in syndication_feeds.txt

This are all purely documentation/explanation changes. We aren't doing anything fundamentally wrong in the code (outside of HttpRedirect) that I know of.

Attachments (0)

Change History (2)

comment:1 Changed 7 years ago by Gary Wilson <gary.wilson@…>

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 7 years ago by dakrauth

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

It appears that Malcom has already added this documentation for the unicode merge.

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.