#28403: FORMAT_MODULE_PATH documentation lacking
------------------------------------------------+------------------------
               Reporter:  karyon                |          Owner:  nobody
                   Type:  Cleanup/optimization  |         Status:  new
              Component:  Documentation         |        Version:  1.11
               Severity:  Normal                |       Keywords:
           Triage Stage:  Unreviewed            |      Has patch:  0
    Needs documentation:  0                     |    Needs tests:  0
Patch needs improvement:  0                     |  Easy pickings:  0
                  UI/UX:  0                     |
------------------------------------------------+------------------------
 two issues with the
 [https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-
 FORMAT_MODULE_PATH documentation for FORMAT_MODULE_PATH]:

 first, it suggests to create this directory structure:

 {{{
 mysite/
     formats/
         __init__.py
         en/
             __init__.py
             formats.py
 }}}

 since i didn't like adding a new {{{formats}}} folder for that, i first
 did not use {{{FORMAT_MODULE_PATH}}}. then i realized i could use the
 locale path for that, and then i saw that even django itself does that.
 so, my first suggestion is to replace {{{formats/}}} by {{{locale/}}} in
 that directory structure, and maybe even explicitly add a sentence how the
 locale directory can be used for the formats.

 second, the docs say something about "available formats are:" and then a
 long list of settings. to me it seems like {{{DATE_INPUT_FORMATS}}} and
 {{{DATETIME_INPUT_FORMATS}}} are missing from this list. if they were
 excluded for a specific reason, that should be stated there as well.

-- 
Ticket URL: <https://code.djangoproject.com/ticket/28403>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/049.0c7a6519907cf9d2dd92e2dd4cebce6b%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to