dj-database-url icon indicating copy to clipboard operation
dj-database-url copied to clipboard

Document the `env` option to `dj_database_url.config`

Open edmorley opened this issue 1 year ago • 2 comments

dj_database_url.config takes an env option that allows for customising the env var used for the database URL away from the default of DATABASE_URL: https://github.com/jazzband/dj-database-url/blob/7906f3bf800105e6ab33bfbf44e6863fd178295a/dj_database_url/init.py#L65-L66

However, this option isn't documented in the README: https://github.com/jazzband/dj-database-url/blob/7906f3bf800105e6ab33bfbf44e6863fd178295a/README.rst#usage

Customising the env var is needed in the case of multiple DBs, where everything but the primary has to use something other than DATABASE_URL.

edmorley avatar May 24 '24 12:05 edmorley

I believe this issue has been resolved by your own contribution? Thank you.

lino avatar Oct 03 '24 03:10 lino

Hi! I'm not sure I follow?

This issue is about the env argument to dj_database_url.config not being documented in the README of this repo.

Checking the README now (using cmd+F -> search for "env") there is still no documentation of the env arg.

edmorley avatar Oct 03 '24 06:10 edmorley