Opened 6 years ago

Closed 5 years ago

Last modified 4 years ago

#10904 closed (fixed)

Fix incorrect term "Absolute URL" throughout documentation

Reported by: sharan666 Owned by: dwillis
Component: Documentation Version: 1.0
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Returns an absolute URL (i.e., a URL without the domain name

should read

Returns an relative URL (i.e., a URL without the domain name

Attachments (1)

10904.diff (8.9 KB) - added by dwillis 5 years ago.

Download all attachments as: .zip

Change History (10)

comment:1 Changed 6 years ago by timo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Looks like this is on docs/ref/templates/builtins.txt

comment:2 Changed 6 years ago by SmileyChris

  • Summary changed from Minor Error with Relative vs. Absolute URL to Fix incorrect term "Absolute URL" throughout documentation
  • Triage Stage changed from Unreviewed to Design decision needed

Even though this is technically correct and Django is in the wrong (http://tools.ietf.org/html/rfc1808), having methods like get_absolute_url() which do the same thing show that the meaning in the documentation is "absolute URL".

A happy medium may be to call it an "absolute URL path"

In any case, fixing this isn't just fixing a minor error in one place, there are references all over the place which should use consistent language:

./faq/usage.txt:       called ``mug_shot``, you can get the absolute URL to your image in a
./intro/tutorial03.txt:All the poll app cares about is its relative URLs, not its absolute URLs.
./topics/auth.txt:          default), passing the current absolute URL in the query string as
./ref/request-response.txt:    absolute URL with no domain (e.g. ``'/search/'``). Note that this returns
./ref/models/instances.txt:In this way, you're tying the model's absolute URL to the view that is used
./ref/models/fields.txt:       you can get the absolute URL to your image in a template with
./ref/templates/builtins.txt:Returns an absolute URL (i.e., a URL without the domain name) matching a given
./ref/contrib/syndication.txt:The :attr:`link` method/attribute can return either an absolute URL (e.g.
./ref/contrib/sitemaps.txt:        If it's a method, it should return the absolute URL for a given object as
./ref/contrib/sitemaps.txt:        If it's an attribute, its value should be a string representing an absolute URL
./ref/contrib/sitemaps.txt:        In both cases, "absolute URL" means a URL that doesn't include the protocol or
./ref/contrib/sitemaps.txt:    which should be the absolute URL of your site's sitemap (e.g.,

comment:3 Changed 5 years ago by mtredinnick

  • Needs documentation set
  • Triage Stage changed from Design decision needed to Accepted

We should definitely fix it and use the phrase "absolute path reference" (possibly abbreviated to "absolute path" after frequent use). That is the term used in RFC 2396, which is the URI spec. The current Django usage has always annoyed me and is almost certainly due to a misunderstanding when the docs were originally written. It's wrong currently; let's fix it.

By the way, we can't use the 'i.e.' phrasing of the current docs after the terms "relative URL" since it's not an "i.e.", it's an "e.g." and that isn't correct in those contexts either.

Changed 5 years ago by dwillis

comment:4 Changed 5 years ago by dwillis

  • Has patch set
  • milestone set to 1.3
  • Owner changed from nobody to dwillis
  • Status changed from new to assigned

comment:5 Changed 5 years ago by dwillis

  • Needs documentation unset

comment:6 Changed 5 years ago by gabrielhurley

+1 for "absolute path". The current usage bugs the heck out of me too. I will start correcting these in other patches as I come across them, in addition to working on this patch.

comment:7 Changed 5 years ago by gabrielhurley

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

(In [14482]) Fixed #10904 -- Corrected inappropriate usage of the term "absolute URL" throughout the docs. Replaced with the (RFC 2396-compliant) terms "absolute path reference" or "absolute path" as appropriate for the context. Thanks to sharan666 for the report, and Malcolm, Chris, and dwillis for their work in supplying a solution and patch.

comment:8 Changed 5 years ago by gabrielhurley

(In [14483]) [1.2.X] Fixed #10904 -- Corrected inappropriate usage of the term "absolute URL" throughout the docs. Replaced with the (RFC 2396-compliant) terms "absolute path reference" or "absolute path" as appropriate for the context. Thanks to sharan666 for the report, and Malcolm, Chris, and dwillis for their work in supplying a solution and patch.

Backport of [14482] from trunk.

comment:9 Changed 4 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

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