#35823: Document examples for all view decorators
-------------------------------------+-------------------------------------
     Reporter:  Adam Johnson         |                    Owner:  (none)
         Type:                       |                   Status:  closed
  Cleanup/optimization               |
    Component:  Documentation        |                  Version:  dev
     Severity:  Normal               |               Resolution:  needsinfo
     Keywords:                       |             Triage Stage:  Accepted
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  0                    |                    UI/UX:  0
-------------------------------------+-------------------------------------
Changes (by Sarah Boyce):

 * resolution:   => needsinfo
 * stage:  Unreviewed => Accepted
 * status:  new => closed

Comment:

 `require_GET/POST/safe` is probably fine as there is an example for
 `require_http_methods`

 Conditional view processing has a topic with examples:
 https://docs.djangoproject.com/en/dev/topics/conditional-view-processing/
 Vary headers has a topic with examples:
 https://docs.djangoproject.com/en/dev/topics/cache/#using-vary-headers
 Cache control is within the cache topic with examples:
 https://docs.djangoproject.com/en/dev/topics/cache/#controlling-cache-
 using-other-headers
 Append slash has an example with the linked middleware:
 
https://docs.djangoproject.com/en/dev/ref/middleware/#django.middleware.common.CommonMiddleware

 GZip compression has no example and doesn't link to the middleware (when I
 think it should): https://docs.djangoproject.com/en/dev/ref/middleware
 /#module-django.middleware.gzip

 So I think it's roughly there but in different places.
 Do you think the examples should be duplicated? Moved over? Or just more
 prominent links to the topics?
-- 
Ticket URL: <https://code.djangoproject.com/ticket/35823#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 view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/01070192758b0264-55f29958-217f-4dda-a6bf-d9dfa43b1791-000000%40eu-central-1.amazonses.com.

Reply via email to