Opened 7 years ago

Closed 7 years ago

Last modified 4 years ago

#8698 closed (fixed)

Middleware Documentation still refers to CacheMiddleware

Reported by: anonymous Owned by: nobody
Component: Documentation Version: master
Severity: Keywords: middleware, cache
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

On the Cache documentation page, it says you have to use UpdateCacheMiddleware and FetchFromCacheMiddleware instead of the older CacheMiddleware. However the Middleware documentation only mentions CacheMiddleware and does not discuss the two new middlewares.

Attachments (1)

8698-middleware-docs-cachemiddleware.diff (770 bytes) - added by akaihola 7 years ago.
patch for middleware documentation

Download all attachments as: .zip

Change History (6)

comment:1 Changed 7 years ago by ubernostrum

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to worksforme
  • Status changed from new to closed

Most people can still use CacheMiddleware, and CacheMiddleware still exists; it's just in certain situations -- as described in the caching docs -- that you need to use the separate bits to avoid problems.

comment:2 Changed 7 years ago by mtredinnick

  • Resolution worksforme deleted
  • Status changed from closed to reopened

This isn't a good default strategy. You can still use CacheMiddleware is it's working for you now or you really know what you're doing. It's far safer to use the split version, though, since it means you can safely add other middleware later without having to hurt your brain trying to work out if it's something that will affect the cache key. It's an omission in the middleware docs, in any case, since these two middleware pieces exist.

Changed 7 years ago by akaihola

patch for middleware documentation

comment:3 Changed 7 years ago by akaihola

  • Has patch set

comment:4 Changed 7 years ago by ubernostrum

  • Resolution set to fixed
  • Status changed from reopened to closed

(In [8791]) Fixed #8698: Updated overview docs for cache middleware to show that it's been split into two classes

comment:5 Changed 4 years ago by jacob

  • milestone 1.0 deleted

Milestone 1.0 deleted

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