Allowed low ranking search results to be returned in doc search.

Author: sarahboyce

djangoproject/scss/_style.scss

@@ -2763,7 +2763,7 @@ form {
         display: block;
         font-weight: 400;
         height: 30px;
-        margin: 10px 0px;
+        margin: 10px 0px 5px;
         padding: 6px 14% 8px 10px;
         text-indent: 0;
         vertical-align: middle;
@@ -2925,7 +2925,13 @@ form {
         margin: 0 0 10px 0;
 
         button {
-            top: 19%;
+            top: 13%;
+        }
+
+        .helptext {
+            font-size: 1.1rem;
+            line-height: 1.5rem;
+            display: block;
         }
     }
 }

docs/models.py

@@ -16,7 +16,7 @@
 )
 from django.core.cache import cache
 from django.db import models, transaction
-from django.db.models import Prefetch, Q
+from django.db.models import Prefetch, Q, F
 from django.db.models.fields.json import KeyTextTransform
 from django.utils.functional import cached_property
 from django.utils.html import strip_tags
@@ -261,11 +261,9 @@ def search(self, query_text, release):
                         "release__release", queryset=Release.objects.only("version")
                     ),
                 )
-                .filter(
-                    release_id=release.id,
-                    search=search_query,
-                )
+                .filter(release_id=release.id)
                 .annotate(
+                    search_query=Q(search=search_query),
                     rank=search_rank + similarity,
                     headline=SearchHeadline(
                         "title",
@@ -283,11 +281,9 @@ def search(self, query_text, release):
                     ),
                     breadcrumbs=models.F("metadata__breadcrumbs"),
                 )
-                .order_by("-rank")
-                .only(
-                    "path",
-                    "release",
-                )
+                .filter(Q(search_query=True) | Q(rank__gt=0.3))
+                .order_by("-search_query", "-rank")
+                .only("path", "release")
             )
         else:
             return self.none()

docs/templates/docs/search_form.html

@@ -8,4 +8,9 @@
     <i class="icon icon-search"></i>
     <span class="visuallyhidden">{% trans 'Search' %}</span>
   </button>
+  <span class="helptext quiet">
+    {% blocktranslate trimmed %}
+      Uses PostgreSQL <code>websearch_to_tsquery</code> syntax e.g. use "quoted text" for a phrase.
+    {% endblocktranslate %}
+  </span>
 </form>

docs/tests.py

@@ -567,17 +567,21 @@ def test_search(self):
                 ),
             ),
         ]
-        self.assertQuerySetEqual(
-            Document.objects.search("django", self.release),
-            expected_list,
-            transform=attrgetter("rank", "path", "headline", "highlight"),
-        )
+        with self.assertNumQueries(2):
+            self.assertQuerySetEqual(
+                Document.objects.search("django", self.release),
+                expected_list,
+                transform=attrgetter("rank", "path", "headline", "highlight"),
+            )
 
     def test_websearch(self):
         self.assertQuerySetEqual(
             Document.objects.search('django "release notes" -packaging', self.release),
-            [("Django 1.9.4 release notes", 1.5675676)],
-            transform=attrgetter("title", "rank"),
+            [
+                ("Django 1.9.4 release notes", 1.5675676, True),
+                ("Django 1.2.1 release notes", 1.6, False),
+            ],
+            transform=attrgetter("title", "rank", "search_query"),
         )
 
     def test_multilingual_search(self):
@@ -642,6 +646,15 @@ def test_search_highlight_stemmed(self):
             transform=attrgetter("headline", "highlight"),
         )
 
+    def test_search_title(self):
+        misspelled_query = Document.objects.search("viewss", self.release)
+        with self.assertNumQueries(2):
+            self.assertQuerySetEqual(
+                misspelled_query,
+                ["Generic views"],
+                transform=attrgetter("headline"),
+            )
+
 
 class TemplateTestCase(TestCase):
     def _assertOGTitleEqual(self, doc, expected):