Opened 5 years ago

Closed 5 years ago

#14085 closed (fixed)

DATE_FORMAT, TIME_FORMAT etc. docs should have a link to allowed formatting strings

Reported by: Miikka 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

From the page http://docs.djangoproject.com/en/dev/ref/settings/#date-format:

DATE_FORMAT
Default: 'N j, Y' (e.g. Feb. 4, 2003)

The default formatting to use for displaying date fields in any part of the system.
Note that if USE_L10N is set to True, then the locale-dictated format has higher
precedence and will be applied instead. See allowed date format strings.

I gather "allowed date format strings" should be a link to now template tag documentation, but it isn't a link at all. Same goes for DATETIME_FORMAT, TIME_FORMAT and all the other date/time formatting related settings.

Change History (4)

comment:1 Changed 5 years ago by ramiro

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

You are right. This is happening with five of the six custom xrefs/objects types defined by the Django docs.

Setting xrefs works, template tags (the one bitting you), template filters, ORM query lookups, django-admin commands, django-admin command line switches don't.

AFAICT this is a bug introduced in Sphinx with the domain support code new in 1.0. This has been reported as ticket 490 on the Sphinx bug tracker.

comment:2 Changed 5 years ago by ramiro

The Sphinx bug is fixed in the just released version 1.0.2. #14111 deals with documenting the new version requirement.

See also #14033.

After that, we'd need to update the Sphinx 1.0 installation on docs.djangoproject.com to 1.0.2 ASAP to take advantage of these fixes and restore the internal links.

comment:3 Changed 5 years ago by dwillis

  • Version changed from 1.2 to SVN

Note that #13188, which has a patch submitted, moves the formatting docs from now to date.

comment:4 Changed 5 years ago by ramiro

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

This has been fixed in the djangoproject.com server at some point since then.

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