Opened 2 weeks ago

Closed 10 days ago

Last modified 10 days ago

#28777 closed Cleanup/optimization (fixed)

Clarify the docs for admin's @register's arguments

Reported by: Matt Swan Owned by: nobody
Component: Documentation Version: 1.11
Severity: Normal Keywords: register decorator
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 (last modified by Matt Swan)

The description text for the register decorator has a complex sentence that is badly worded and not proper english, meaning that the functions usage is not properly described.

This page:
https://docs.djangoproject.com/en/1.11/ref/contrib/admin/
Please reword this sentence so it make sense:

It is given one or more model classes to register with the ModelAdmin and an optional keyword argument site if you are not using the default AdminSite:

Suggested changes - but I don't understand the sentence so the suggestion is just a guess:

"It is given IF/FOR(?) one or more model classes to register with the ModelAdmin and an optional keyword argument site FULL STOP. If you are not using the default AdminSite:"

Change History (5)

comment:1 Changed 2 weeks ago by Matt Swan

Description: modified (diff)

comment:2 Changed 13 days ago by Tim Graham

Has patch: set
Summary: The register decorator description is badly worded - needs clarificationClarify the docs for admin's @register's arguments
Triage Stage: UnreviewedAccepted

Does this PR clarify?

comment:3 Changed 11 days ago by Bjorn Kristinsson

Triage Stage: AcceptedReady for checkin

comment:4 Changed 10 days ago by GitHub <noreply@…>

Resolution: fixed
Status: newclosed

In abaf0ab4:

Fixed #28777 -- Clarified the docs for admin.register's args.

comment:5 Changed 10 days ago by Tim Graham <timograham@…>

In 3c8c3ff6:

[2.0.x] Fixed #28777 -- Clarified the docs for admin.register's args.

Backport of abaf0ab4a444977dc8ac07b9b63256814c352245 from master

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