http://api.drupal.org/api/function/format_date

This page talks about being able to set formatting strings for 'small', 'medium' and 'large' date formats in the admin section. This, however, isn't the case. It's 'short', 'medium' and 'long' instead. Ideally both should match but at this stage only the types in the doc can be used.

Comments

minoroffense’s picture

Assigned: Unassigned » minoroffense
minoroffense’s picture

Status: Active » Closed (works as designed)

Even though most languages refer to dates as "short", "medium" and "long" the documentation matches the code (see common.inc file in latest drupal 6 build). So there's really nothing wrong with the docs.

Just want to note that Drupal 7 has the same references in its API docs so if you'd like to make a patch or create an issue to add support for "short", "medium" and "long" date format names in Drupal 7, feel free to do so.

jeffschuler’s picture

Version: 6.0-rc4 » 7.x-dev
Assigned: minoroffense » Unassigned
Status: Closed (works as designed) » Active

See #368408: Consistent date length nomenclature in format_date(): naming for these in 7.x core code has been made consistent: short, medium, and long.

The handbook should now reflect that for 7.x, so I'm re-opening this issue.

@minorOffense, feel free to reassign this to yourself if appropriate.

jeffschuler’s picture

OK, I'm not super familiar with the handbook, so I don't know if I'm looking in the right direction, but I've done some searching around d.o. to find docs and issues related to this, (mostly searching for format_date and small / large,) and found the following links to have info that is made out-of-date by this change.

in the Handbook:

in the Forums:

Many of these relate to Drupal 4.x or 5.x, and/or might not be appropriate to correct, but I'm trying to kick this off a bit, and hope someone more familiar with docs can help out here.

jhodgdon’s picture

Project: Drupal core » Documentation
Version: 7.x-dev »
Component: documentation » Correction/Clarification

This issue relates to documentation in the Handbook. Moving to correct issue queue.

jeffschuler’s picture

(Thanks Jennifer.)

I see now that this -- well, the change in #368408: Consistent date length nomenclature in format_date() -- needs to be added to Converting 6.x modules to 7.x (and Converting 6.x modules to 7.x - Categorical)...

jhodgdon’s picture

In that case, the other issue should have been marked as "needs work" with tag "Needs Documentation" instead of "fixed".

jeffschuler’s picture

Thanks @jhodgdon; done so.

jhodgdon’s picture

Title: format_date types doesn't match admin format strings » Handbook is not up to date on format_date
jhodgdon’s picture

Issue tags: +developer, +d7docs

tagging

jhodgdon’s picture

Status: Active » Fixed

All of the above pages (except one that has been archived) have their status updated to say "needs updating", and a comment linking to this issue.

We aren't using Documentation issue reports to report problems with Community Documentation pages any more in general... so please feel free to edit the pages... for now, that will take care of it at least.

Status: Fixed » Closed (fixed)
Issue tags: -developer, -d7docs

Automatically closed -- issue fixed for 2 weeks with no activity.