Django

Code

Ticket #9986 (closed: fixed)

Opened 1 year ago

Last modified 1 year ago

CACHE_BACKEND argument name doesn't match code

Reported by: john_scott Assigned to: jacob
Milestone: 1.1 Component: Documentation
Version: 1.0 Keywords:
Cc: Triage Stage: Accepted
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

According to the cache docs, there is a parameter called cull_percentage but in the code, this is called cull_frequency and there is no reference in the code at all to cull_percentage. Apparently this hasn't bitten anyone as the problem was first noticed over a year ago.

From my understanding of the code, cull_percentage is a more accurate description of what happens but this would require changing code to match the docs. I have no skin in this game as I don't use any of the affected cache backends, I just noticed it while reviewing the settings relevant to memcache.

Attachments

cull_frequency.diff (1.1 kB) - added by kgrandis on 03/29/09 08:14:13.
patch that does the opposite of ticket and replaces cull_percentage with cull_frequency

Change History

02/26/09 19:46:36 changed by jacob

  • needs_better_patch changed.
  • needs_docs changed.
  • stage changed from Unreviewed to Accepted.
  • needs_tests changed.
  • milestone set to 1.1.

03/29/09 00:54:15 changed by kgrandis

The code blocks where cull_frequency actually does its magic show that it is actually doing a frequency calculations:

doomed = [os.path.join(self._dir, k) for (i, k) in enumerate(filelist) if i % self._cull_frequency == 0]

and

doomed = [k for (i, k) in enumerate(self._cache) if i % self._cull_frequency == 0]

The default cull_frequency is 3, so the above code would flag every 3rd item as doomed (1/f or 1/3). I also have no skin in the game as I have not made use of this particular parameter, but I do think the code name, cull_frequency, is the more accurate description.

03/29/09 08:14:13 changed by kgrandis

  • attachment cull_frequency.diff added.

patch that does the opposite of ticket and replaces cull_percentage with cull_frequency

03/29/09 08:15:28 changed by kgrandis

  • has_patch set to 1.

04/02/09 13:42:41 changed by jacob

  • owner changed from nobody to jacob.
  • status changed from new to assigned.

04/03/09 13:30:55 changed by jacob

  • status changed from assigned to closed.
  • resolution set to fixed.

(In [10371]) Fixed a whole bunch of small docs typos, errors, and ommissions.

Fixes #8358, #8396, #8724, #9043, #9128, #9247, #9267, #9267, #9375, #9409, #9414, #9416, #9446, #9454, #9464, #9503, #9518, #9533, #9657, #9658, #9683, #9733, #9771, #9835, #9836, #9837, #9897, #9906, #9912, #9945, #9986, #9992, #10055, #10084, #10091, #10145, #10245, #10257, #10309, #10358, #10359, #10424, #10426, #10508, #10531, #10551, #10635, #10637, #10656, #10658, #10690, #10699, #19528.

Thanks to all the respective authors of those tickets.


Add/Change #9986 (CACHE_BACKEND argument name doesn't match code)




Change Properties
Action