#32570 closed Cleanup/optimization (fixed)
Documentation example for AppConfig is overloaded
| Reported by: | Aymeric Augustin | Owned by: | Kshitij Raghav |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| 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
In https://docs.djangoproject.com/en/dev/ref/applications/#for-application-authors the example shows default_auto_field = 'django.db.models.BigAutoField' which isn't necessary for the purposes of the example ("here’s how you would provide a proper name for the admin") and isn't explained either. This may create confusion; I suggest we remove this line.
Change History (6)
comment:1 by , 4 years ago
| Easy pickings: | set |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
| Type: | Bug → Cleanup/optimization |
comment:2 by , 4 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
comment:3 by , 4 years ago
Sucessfully removed "default_auto_field = 'django.db.models.BigAutoField' that was causing confusion.
Note:
See TracTickets
for help on using tickets.
This is a minimal example that doesn't raise error messages. I'm not sure if it's worth removing this single line, but if it's confusing for anyone then we can do this.