search

joke2k / django-environ

Django-environ allows you to utilize 12factor inspired environment variables to configure your Django application.
https://django-environ.rtfd.org
MIT License
3.02k stars 316 forks source link

Documentation of Usage is Poor #94

Open dvf opened 8 years ago

dvf commented 8 years ago

It would be great for the documentation to clarify best practice usage, for example, it's unclear whether I should be importing variables from settings in a module or directly importing from Environ:

from django.conf import settings

my_var = settings.MY_VAR
...

For a tool born out of best-practices, it would be great if we could clean up the documentation with some use cases.

esseti commented 7 years ago

I would probably add some example, one for each type.

pataquets commented 7 months ago

[Issue gardening] @dvf, @esseti: Do you still find anything missing from the docs (it's been 8 year since the issue was open)? @dvf If not, fancy to close the issue? (it would be better to file new issues with more specific needs)

esseti commented 6 months ago

Close it, it seems that thare are few additonal example right now, and since in the meanwhile no-one requested new "updates" you could assume that people understand the doc.

pataquets commented 6 months ago

Great to know, thanks for the feedback. I can't close the issue, since I'm no admin/contributor. Let's see what @dvf has to say, and if everything it's ok, he can close it.

pataquets commented 6 months ago

@dvf: fancy to close the issue in case you're not missing some specific example? Let's help maintainers save time and keep focus :wink: