[Docs] Fix typo on filter name

[vbuxbaum]

Hi everyone!

I was studying Jinja and Flask with @JefersonViana , and noticed a typo in the docs about custom filters.

I hope there is no need for creating an issue for this.

Let me know if you think that there is a better solution.

[davidism]

The typo would be in the use, not the registration. Always prefer separated words, so |datetime_filter. (Yes, "datetime" itself doesn't follow this, but it's the built-in name.)

[davidism]

Be sure to make docs fixes against the latest feature branch (3.1.x) rather than main so that it gets into the current docs. You'll need to rebase and force push to fix that:

$ git rebase --onto origin/3.1.x origin/main
$ git push -f

After you do that you'll only see your commit on this page instead of the huge list.

[vbuxbaum]

Be sure to make docs fixes against the latest feature branch (3.1.x)

Thanks @davidism ! I did not pay attention to that, sorry. Done ✅

The typo would be in the use, not the registration. Always prefer separated words, so |datetime_filter. (Yes, "datetime" itself doesn't follow this, but it's the built-in name.)

The current filter's name is datetime_format. Your suggestion is to change to datetime_filter, or it was a typo? I don't think using _filter in a filter name is necessary, although it helps the explanation.

I also prefer naming separating words with _, but I think it is better if the filter function and the register in environment.filters have different names. Someone (mainly beginners) may wonder

• "is it necessary to keep the same name?"
• or even "which should be used inside the template? the function's name or the string registered in environment.filters"

What if we rename the datetime_format function to datetime_format_filter, and keep the filter's name as datetime_format?

[davidism]

datetime_format everywhere please.

[vbuxbaum]

datetime_format everywhere please.

@davidism done ✅

[vbuxbaum]

The pre-commit.ci failure has nothing to do with my changes, right? Do I need to do something about it?