Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of Usage is Poor #94

Open
dvf opened this issue Sep 12, 2016 · 5 comments
Open

Documentation of Usage is Poor #94

dvf opened this issue Sep 12, 2016 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@dvf
Copy link

dvf commented Sep 12, 2016

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
Copy link

esseti commented Mar 3, 2017

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

@sergeyklay sergeyklay added the documentation Improvements or additions to documentation label Sep 4, 2021
@pataquets
Copy link

[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
Copy link

esseti commented Apr 18, 2024

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
Copy link

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants