Browse Source

[5.0.x] Fixed #35153 -- Added note about locale name notation to FORMAT_MODULE_PATH docs.

Co-authored-by: Paul Hermans <paul.hermans@benemtech.com>

Backport of 9bd849c8d5c587209a231af643a17ec2db802ab2 from main
sandjio 1 year ago
parent
commit
e72fdc850a
1 changed files with 4 additions and 0 deletions
  1. 4 0
      docs/ref/settings.txt

+ 4 - 0
docs/ref/settings.txt

@@ -1728,6 +1728,10 @@ for project locales. If not ``None``, Django will check for a ``formats.py``
 file, under the directory named as the current locale, and will use the
 file, under the directory named as the current locale, and will use the
 formats defined in this file.
 formats defined in this file.
 
 
+The name of the directory containing the format definitions is expected to be
+named using :term:`locale name` notation, for example ``de``, ``pt_BR``,
+``en_US``, etc.
+
 For example, if :setting:`FORMAT_MODULE_PATH` is set to ``mysite.formats``,
 For example, if :setting:`FORMAT_MODULE_PATH` is set to ``mysite.formats``,
 and current language is ``en`` (English), Django will expect a directory tree
 and current language is ``en`` (English), Django will expect a directory tree
 like:
 like: