From cda6878486a24b4005c60b66cf7cbc97594b5faf Mon Sep 17 00:00:00 2001 From: Charlie Smith Date: Sat, 30 Sep 2017 13:18:55 +0100 Subject: [PATCH] More inline docs for DATABASES variable (#1350) * More inline docs for DATABASES variable Use of database url is not part of Django, but comes from django-environ. Was initially confusing where feature came from, as link points to offical django docs. * Contributors update --- CONTRIBUTORS.rst | 2 ++ {{cookiecutter.project_slug}}/config/settings/base.py | 2 ++ 2 files changed, 4 insertions(+) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index d4e1bfe90..08bca9078 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -68,6 +68,7 @@ Listed in alphabetical order. Burhan Khalid            `@burhan`_                   @burhan Catherine Devlin `@catherinedevlin`_ Cédric Gaspoz `@cgaspoz`_ + Charlie Smith `@chuckus`_ Chris Curvey `@ccurvey`_ Chris Franklin Chris Franklin `@hairychris`_ @@ -179,6 +180,7 @@ Listed in alphabetical order. .. _@cgaspoz: https://github.com/cgaspoz .. _@chrisdev: https://github.com/chrisdev .. _@ChrisPappalardo: https://github.com/ChrisPappalardo +.. _@chuckus: https://github.com/chuckus .. _@Collederas: https://github.com/Collederas .. _@ddiazpinto: https://github.com/ddiazpinto .. _@dezoito: https://github.com/dezoito diff --git a/{{cookiecutter.project_slug}}/config/settings/base.py b/{{cookiecutter.project_slug}}/config/settings/base.py index 274e28067..10261781d 100644 --- a/{{cookiecutter.project_slug}}/config/settings/base.py +++ b/{{cookiecutter.project_slug}}/config/settings/base.py @@ -108,6 +108,8 @@ MANAGERS = ADMINS # DATABASE CONFIGURATION # ------------------------------------------------------------------------------ # See: https://docs.djangoproject.com/en/dev/ref/settings/#databases +# Uses django-environ to accept uri format +# See: https://django-environ.readthedocs.io/en/latest/#supported-types DATABASES = { 'default': env.db('DATABASE_URL', default='postgres://{% if cookiecutter.windows == 'y' %}localhost{% endif %}/{{cookiecutter.project_slug}}'), }