Opened 7 years ago

Closed 7 years ago

#22124 closed Cleanup/optimization (fixed)

Expand the Documentation of Custom Lookups for V1.7

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 Baptiste Mispelon)

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:

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 (2)

comment:1 Changed 7 years ago by Baptiste Mispelon

Description: modified (diff)
Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization
Version: 1.6master

I'll mark this ticket as accepted on 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?

comment:2 Changed 7 years ago by Marc Tamlyn <marc.tamlyn@…>

Resolution: fixed
Status: newclosed

In 219d928852c256a81d09dbaa29ed4cec42d2fdfa:

Fixed #21863 -- supplemented get_lookup() with get_transform()

Also fixed #22124 -- Expanded explanation of exactly what is going on in
as_sql() methods.

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