Opened 9 years ago

Closed 9 years ago

Last modified 9 years ago

#25681 closed Bug (fixed)

Possible minor contradiction in DATABASES setting depicted in multiple database/routing docs example.

Reported by: aleks Owned by: Tim Graham <timograham@…>
Component: Documentation Version: 1.8
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

Whilst perusing the (excellent) documentation, I noticed that in the 'Multiple databases' docs (https://docs.djangoproject.com/en/1.8/topics/db/multi-db/), the section 'Defining your databases' states: "Django requires that a default database entry be defined, but the parameters dictionary can be left blank if it will not be used"...

However in the example later in this section (https://docs.djangoproject.com/en/1.8/topics/db/multi-db/#an-example), the default value is not defined.

I fully appreciate this is an example, which as stated skips some complex considerations, however from what I understood, the default value is a *requirement* not a consideration as such?

Or have I misunderstood/misread the requirement for the 'default' value when using custom routers? (in which case my apologies!)

Change History (7)

comment:1 by Tim Graham, 9 years ago

Easy pickings: set
Triage Stage: UnreviewedAccepted
Type: UncategorizedBug

I believe the correct solution is to add 'default': {} to those examples, but we should double check.

comment:2 by Iacopo Spalletti, 9 years ago

Owner: changed from nobody to Iacopo Spalletti
Status: newassigned

comment:3 by Tim Graham, 9 years ago

Has patch: set

comment:4 by Iacopo Spalletti, 9 years ago

Owner: Iacopo Spalletti removed
Status: assignednew
Triage Stage: AcceptedReady for checkin

Setting DATABASES as stated in current documentation returns an error.
Linked PR fixes the issue

Last edited 9 years ago by Iacopo Spalletti (previous) (diff)

comment:5 by Tim Graham <timograham@…>, 9 years ago

Owner: set to Tim Graham <timograham@…>
Resolution: fixed
Status: newclosed

In ac750db:

Fixed #25681 -- Added 'default' to DATABASES example.

comment:6 by Tim Graham <timograham@…>, 9 years ago

In a98d08f9:

[1.9.x] Fixed #25681 -- Added 'default' to DATABASES example.

Backport of ac750dbbc0533dcf9c2f6c0f09957adf6f976d3e from master

comment:7 by Tim Graham <timograham@…>, 9 years ago

In 189ceae1:

[1.8.x] Fixed #25681 -- Added 'default' to DATABASES example.

Backport of ac750dbbc0533dcf9c2f6c0f09957adf6f976d3e from master

Note: See TracTickets for help on using tickets.
Back to Top