#28777: The register decorator description is badly worded - needs clarification
-------------------------------------+-------------------------------------
Reporter: Matt Swan | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 1.11
Severity: Normal | Resolution:
Keywords: register decorator | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Description changed by Matt Swan:
Old description:
> 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:"
New description:
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:"
--
--
Ticket URL: <https://code.djangoproject.com/ticket/28777#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/067.af81732177ec18f24a8ac99e061695c4%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
