Opened 12 years ago
Last modified 12 years ago
#22124 closed Cleanup/optimization
Expand the Documentation of Custom Lookups for V1.7 — at Initial Version
| Reported by: | Maarten | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
Custom Lookups look great, however, I find the documentation terse. Example: no explanation what
lhs, lhs_params = self.process_lhs(qn, connection)
is exactly.
The explanation: "lhs
The lhs (left-hand side) of a lookup tells us what we are comparing the rhs to. It is an object which implements the query expression API. This is likely to be a field, an aggregate or a subclass of Transform.
does not explain" does not explain what lhs_params might be. Also a search on "process_lhs" on complete Django website only points to this page (no other pages).