Summary

Add a guide on caching data.

Review Request #14873 — Created March 5, 2026 and submitted March 19, 2026, 8:12 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

This introduces the first of a series of caching guides, focusing on
using cache_memoize() and cache_memoize_iter(). This covers basic
usage, iterables, force-overrides, large data, compression, encryption,
and locking, all with examples covering both functions.

Testing Done

Built the docs. Checked for build errors, spelling errors, and bad
links.

Commits

Summary	ID
Add a guide on caching data. This introduces the first of a series of caching guides, focusing on using `cache_memoize()` and `cache_memoize_iter()`. This covers basic usage, iterables, force-overrides, large data, compression, encryption, and locking,all with examples covering both functions.	064d96e7ff38d4df992c45465c83d9bfbe441fdc

Issues

Description	From	Last Updated
Typo in description: locking,all -> locking, all	david	March 9, 2026, 11:24 p.m.
Typo: of of	david	March 9, 2026, 11:24 p.m.
Can we include an import for Iterator?	david	March 9, 2026, 11:24 p.m.
It's probably more correct to say this returns Iterator	david	March 9, 2026, 11:24 p.m.
Typo: ofr -> for Though it might be better to say something like "This is always enabled for cache_memoize_iter"	david	March 9, 2026, 11:25 p.m.

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

Typo in description: locking,all -> locking, all

docs/djblets/guides/caching/caching-data.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Typo: of of
```
docs/djblets/guides/caching/caching-data.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we include an import for Iterator?
```
docs/djblets/guides/caching/caching-data.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
It's probably more correct to say this returns Iterator
```

docs/djblets/guides/caching/caching-data.rst (Diff revision 1)

The issue has been resolved. Show all issues

Typo: ofr -> for

Though it might be better to say something like "This is always enabled for cache_memoize_iter"

Change Summary:


Fixed several typos.
Switched a code example to Iterator instead of Iterable.
Improved wording around large data in cache_memoize_iter.

Description:

		This introduces the first of a series of caching guides, focusing on
		using `cache_memoize()` and `cache_memoize_iter()`. This covers basic
		usage, iterables, force-overrides, large data, compression, encryption,
~		and locking,all with examples covering both functions.
	~	and locking, all with examples covering both functions.

Commits:

	Summary	ID
	Add a guide on caching data. This introduces the first of a series of caching guides, focusing on using `cache_memoize()` and `cache_memoize_iter()`. This covers basic usage, iterables, force-overrides, large data, compression, encryption, and locking,all with examples covering both functions.	f3844c4ab3151b3720d42cf69d00de6c83a7fddc
	Add a guide on caching data. This introduces the first of a series of caching guides, focusing on using `cache_memoize()` and `cache_memoize_iter()`. This covers basic usage, iterables, force-overrides, large data, compression, encryption, and locking,all with examples covering both functions.	064d96e7ff38d4df992c45465c83d9bfbe441fdc

Diff:

Revision 2 (+564)

Show changes

	docs/djblets/coderef/index.rst
	docs/djblets/guides/index.rst
	docs/djblets/guides/caching/caching-data.rst
	docs/djblets/guides/caching/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (c48b9d1)