#22812: Reformat and restructure lookup API documentation
--------------------------------------+----------------------------
Reporter: jorgecarleitao | Owner: jorgecarleitao
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+----------------------------
Currently the API documentation docs/ref/models/custom-lookups.txt has
some formatting issues, and mixes the howto with the API references, see
https://docs.djangoproject.com/en/dev/ref/models/custom-lookups/
Here I'm proposing to separate these two concepts:
1. Adding a new howto - docs/howto/custom-lookups.txt - for custom
lookups, which includes section
https://docs.djangoproject.com/en/dev/ref/models/custom-lookups/#a-simple-
lookup-example to section https://docs.djangoproject.com/en/dev/ref/models
/custom-lookups/#how-django-determines-the-lookups-and-transforms-which-
are-used with potential improvements.
2. Renaming "custom-lookups.txt" to "lookups.txt" in ref/models to be the
documentation of lookups API, with references for the public interfaces of
`RegisterLookupMixin`, `Lookup`, `Transform`.
Optionally, because the BuiltIn lookups are part of this new API, they
could be documented in 2., but this may not be possible due to backward
compatibility of documentation urls (devs?)
--
Ticket URL: <https://code.djangoproject.com/ticket/22812>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/057.2b36ce40df467088e1eb4a59c5102d1c%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
