Opened 11 years ago
Last modified 11 years ago
#22124 closed Cleanup/optimization
Expand the Documentation of Custom Lookups for V1.7 — at Version 1
| 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 (last modified by )
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 what lhs_params might be. Also a search on process_lhs on complete Django website only points to this page (no other pages).
Change History (1)
comment:1 by , 11 years ago
| Description: | modified (diff) |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
| Type: | Uncategorized → Cleanup/optimization |
| Version: | 1.6 → master |
Note:
See TracTickets
for help on using tickets.
I'll mark this ticket as
acceptedon the basis that there's probably some improvements to be made on this fairly new part of our documentation.Are there other points beside the one you mentionned in the ticket that you think could be improved?