#27355: Emphasizes the role of TrigramExtension and UnaccentExtension in the
documentation
-------------------------------------+-------------------------------------
     Reporter:  Maxime Lorant        |      Owner:  nobody
         Type:                       |     Status:  new
  Cleanup/optimization               |
    Component:  Documentation        |    Version:  1.10
     Severity:  Normal               |   Keywords:  postgres unaccent
                                     |  trigram
 Triage Stage:  Unreviewed           |  Has patch:  0
Easy pickings:  1                    |      UI/UX:  0
-------------------------------------+-------------------------------------
 `TrigramExtension` and `UnaccentExtension` have been introduced in
 `django.contrib.postgres` in Django 1.10 to help developpers to activate
 the pg_trim and unaccent extension of postgres when they are using the
 corresponding ORM lookup.

 Even though I feel pretty comfortable with the Django doc usually, this
 time, I did not find `UnaccentExtension` in few minutes. In local, I did
 the extension activation by myself (since I did not read the relevant part
 of the doc) but get stuck when trying to execute my unit tests. I think
 these migration operations are not stressed enough in the doc. I believe
 it is [referenced only
 here](https://docs.djangoproject.com/en/1.10/ref/contrib/postgres/lookups/),
 each time in a sentence which barely says when to use it.

 I think there should be an introduction at the top of the page linked
 above saying something like: "The lookups above need the activation of
 extensions in Postgres. To enable them, you are advised to create a Django
 migration which will apply the relevant operation", where the "relevant
 operation" is referring to either TrigramExtension or UnaccentExtension,
 but I don't know how to transcribe it :/

--
Ticket URL: <https://code.djangoproject.com/ticket/27355>
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/050.92f92916f55e8cacebff891d38225aa3%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to