[Django] #32570: Documentation example for AppConfig is overloaded
Django
--------------------------------------------+------------------------
Reporter: Aymeric Augustin | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: dev
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
--------------------------------------------+------------------------
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/32570>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Aymeric Augustin | Owner: nobody
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
--------------------------------------+------------------------------------
Changes (by Mariusz Felisiak):
* type: Bug => Cleanup/optimization
* easy: 0 => 1
* stage: Unreviewed => Accepted
Comment:
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/32570#comment:1>
Django
Reporter: Aymeric Augustin | Owner: Kshitij
Type: | Raghav
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Changes (by Kshitij Raghav):
* owner: nobody => Kshitij Raghav
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/32570#comment:2>
Django
Reporter: Aymeric Augustin | Owner: Kshitij
Type: | Raghav
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Comment (by Kshitij Raghav):
Sucessfully removed "default_auto_field = 'django.db.models.BigAutoField'
that was causing confusion.
--
Ticket URL: <https://code.djangoproject.com/ticket/32570#comment:3>
Django
Reporter: Aymeric Augustin | Owner: Kshitij
Type: | Raghav
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* has_patch: 0 => 1
* stage: Accepted => Ready for checkin
Comment:
[https://github.com/django/django/pull/14152 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/32570#comment:4>
Django
Reporter: Aymeric Augustin | Owner: Kshitij
Type: | Raghav
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"d40402cfb023801f0d83f19747e30b13096e3636" d40402c]:
{{{
#!CommitTicketReference repository=""
revision="d40402cfb023801f0d83f19747e30b13096e3636"
Fixed #32570 -- Removed unnecessary default_auto_field in app config
example.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32570#comment:5>
Django
Reporter: Aymeric Augustin | Owner: Kshitij
Type: | Raghav
Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"fb92a9e2879d9944244300353e8c8c72cc5d8e5f" fb92a9e]:
{{{
#!CommitTicketReference repository=""
revision="fb92a9e2879d9944244300353e8c8c72cc5d8e5f"
[3.2.x] Fixed #32570 -- Removed unnecessary default_auto_field in app
config example.
Backport of d40402cfb023801f0d83f19747e30b13096e3636 from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32570#comment:6>