Opened 7 years ago

Last modified 7 years ago

#28777 closed Cleanup/optimization

The register decorator description is badly worded - needs clarification — at Version 1

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 (1)

comment:1 by Matt Swan, 7 years ago

Description: modified (diff)
Note: See TracTickets for help on using tickets.
Back to Top