[Django] #35826: Document usage examples for decorator utils

8 views
Skip to first unread message

Django

unread,
Oct 9, 2024, 2:36:57 PM10/9/24
to django-...@googlegroups.com
#35826: Document usage examples for decorator utils
-------------------------------------+-------------------------------------
Reporter: Adam Johnson | Type:
| Cleanup/optimization
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
-------------------------------------+-------------------------------------
[https://docs.djangoproject.com/en/dev/ref/utils/#module-
django.utils.decorators This documentation section] lacks usage
examples—let's add some! The tools are quite opaque otherwise, it's not
even clear that some are decorators.
--
Ticket URL: <https://code.djangoproject.com/ticket/35826>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Oct 10, 2024, 2:19:23 PM10/10/24
to django-...@googlegroups.com
#35826: Document usage examples for decorator utils
-------------------------------------+-------------------------------------
Reporter: Adam Johnson | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Natalia Bidart):

Hello Adam, thanks for this ticket! I'm generally in favor of better and
clearer docs.

But, for the specific docs section that you reference, wouldn't the
examples linked from there ("''See decorating class based views for
example usage.''") be the ones you are looking for?
--
Ticket URL: <https://code.djangoproject.com/ticket/35826#comment:1>

Django

unread,
Oct 11, 2024, 10:43:43 AM10/11/24
to django-...@googlegroups.com
#35826: Document usage examples for decorator utils
-------------------------------------+-------------------------------------
Reporter: Adam Johnson | Owner: (none)
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution: needsinfo
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Natalia Bidart):

* resolution: => needsinfo
* status: new => closed

Comment:

Closing as needsinfo to clear our unrtriaged queue, but Adam please reopen
when/if you can provide more specific details. Thank you!
--
Ticket URL: <https://code.djangoproject.com/ticket/35826#comment:2>
Reply all
Reply to author
Forward
0 new messages