Error in documentation simple_tag decorator.

[elbarto]

In ​http://docs.djangoproject.com/en/dev/howto/custom-template-tags/#shortcut-for-simple-tags :

The new examples, that use takes_context argument, have a second argument (format_string) which are never used.

# The first argument *must* be called "context" here.
def current_time(context, format_string):
    timezone = context['timezone']
    return your_get_current_time_method(timezone)

register.simple_tag(takes_context=True)(current_time)

@register.simple_tag(takes_context=True)
def current_time(context, format_string):
    timezone = context['timezone']
    return your_get_current_time_method(timezone)

I fixed it with a patch.

[Russell Keith-Magee]

Accepted that the example is at least slightly ambiguous; however, the ambiguity should be fixed by using the argument, not by removing it. The point of the example is to demonstrate that "context" must be the first argument, not to say that you can't have other arguments.

[elbarto]

Included the arguments in the fictitious your_get_current_time_method().

[Gabriel Hurley]

In [15448]:

Fixed #15138 -- Clarified a slightly ambiguous example in the custom template tag docs. Thanks to elbarto for the report and patch.