[Django] #28403: FORMAT_MODULE_PATH documentation lacking

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[Django] #28403: FORMAT_MODULE_PATH documentation lacking

Django
#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 [hidden email].
To post to this group, send email to [hidden email].
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 | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [Django] #28403: Improve the example for FORMAT_MODULE_PATH and add missing formats (was: FORMAT_MODULE_PATH documentation lacking)

Django
#28403: Improve the example for FORMAT_MODULE_PATH and add missing formats
--------------------------------------+------------------------------------
     Reporter:  karyon                |                    Owner:  nobody
         Type:  Cleanup/optimization  |                   Status:  new
    Component:  Documentation         |                  Version:  1.11
     Severity:  Normal                |               Resolution:
     Keywords:                        |             Triage Stage:  Accepted
    Has patch:  0                     |      Needs documentation:  0
  Needs tests:  0                     |  Patch needs improvement:  0
Easy pickings:  0                     |                    UI/UX:  0
--------------------------------------+------------------------------------
Changes (by Tim Graham):

 * stage:  Unreviewed => Accepted


Comment:

 Is there a need to use `FORMAT_MODULE_PATH` if you use the `locale`
 structure? Are you adding other files in there besides formats? I don't
 know enough one way or another to say that the original decision to use a
 directory called `formats` isn't better. Perhaps you can propose a patch
 to clarify exactly what you did differently.

 The second point about the missing formats seems valid. For future
 reference, I'd have created two tickets rather than grouping somewhat
 related issues together.

--
Ticket URL: <https://code.djangoproject.com/ticket/28403#comment:1>
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 [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/064.15f716b8e9549e5185e4881e52f82f65%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Loading...