chore: PR feedback, remove description

Author: zachdaniel

assets/js/autocomplete/suggestions.js

@@ -147,7 +147,7 @@ function nodeSectionSuggestion (node, section, query, category, label) {
 
   let link
 
-  if (section.anchor === '' || !section.anchor) {
+  if (section.anchor === '') {
     link = `${node.id}.html`
   } else {
     link = `${node.id}.html#${section.anchor}`
@@ -156,7 +156,7 @@ function nodeSectionSuggestion (node, section, query, category, label) {
   return {
     link,
     title: highlightMatches(section.id, query),
-    description: section.description || node.title,
+    description: node.title,
     matchQuality: matchQuality(section.id, query),
     labels: section.labels || [label, 'section'],
     category

assets/test/autocomplete/suggestions.spec.js

@@ -64,8 +64,8 @@ describe('getSuggestions', () => {
           title: 'API Reference'
         },
         {
-          title: "how-to-make-things",
-          description: "How to make things",
+          id: "how-to-make-things",
+          title: "How to make things",
           searchData: [
             {
               id: "custom-text",

lib/ex_doc/formatter/html.ex

@@ -6,7 +6,7 @@ defmodule ExDoc.Formatter.HTML do
 
   @main "api-reference"
   @assets_dir "assets"
-  @search_data_keys [:anchor, :body, :description, :title, :type]
+  @search_data_keys [:anchor, :body, :title, :type]
 
   @doc """
   Generates HTML documentation for the given modules.

lib/ex_doc/formatter/html/templates.ex

@@ -96,10 +96,11 @@ defmodule ExDoc.Formatter.HTML.Templates do
         %{search_data: search_data} when is_list(search_data) ->
           search_data =
             Enum.map(search_data, fn search_item ->
-              search_item
-              |> Map.take([:description, :anchor])
-              |> Map.put(:id, search_item.title)
-              |> Map.put(:labels, [search_item.type])
+              %{
+                anchor: search_item.anchor,
+                id: search_item.title,
+                labels: [search_item.type]
+              }
             end)
 
           Map.put(item, :searchData, search_data)

lib/mix/tasks/docs.ex

@@ -363,11 +363,13 @@ defmodule Mix.Tasks.Docs do
 
   ## Customizing Extras
 
-  - `:title` - The title of the extra page. If not provided, the title will be inferred from the filename.
-  - `:filename` - The name of the generated file. If not provided, the filename will be inferred from the source file.
-  - `:source` - The source file of the extra page. This is useful if you want to customize the filename or title but keep the source file unchanged.
-  - `:search_data` - A list of terms to be indexed for autocomplete and search. If not provided, the content of the extra page will be indexed for search.
-     See the section below for more.
+    * `:title` - The title of the extra page. If not provided, the title will be inferred from the filename. 
+    * `:filename` - The name of the generated file. If not provided, the filename will be inferred from 
+       the source file.
+    * `:source` - The source file of the extra page. This is useful if you want to customize the filename or 
+       title but keep the source file unchanged. *
+    `:search_data` - A list of terms to be indexed for autocomplete and search. If not provided, the content 
+       of the extra page will be indexed for search. See the section below for more.
 
   ### Customizing Search Data
 
@@ -376,11 +378,10 @@ defmodule Mix.Tasks.Docs do
   overrides the built in logic for indexing your document based on the headers and content of the document.
   The following fields can be provided in a list of maps for `search_data`.
 
-  - `:anchor` - The anchor link for the search result. Use `""` to point to the top of the page.
-  - `:title` - The title of the result.
-  - `:description` - A brief description of the result (used during autocompletion)
-  - `:type` - The type of the search result, such as "module", "function" or "section".
-  - `:body` - The main content or body of the search result, _as markdown_. Used in search, not autocomplete.
+    * `:anchor` - The anchor link for the search result. Use `""` to point to the top of the page.
+    * `:title` - The title of the result.
+    * `:type` - The type of the search result, such as "module", "function" or "section".
+    * `:body` - The main content or body of the search result, _as markdown_. Used in search, not autocomplete.
 
   ## Umbrella project
 

test/ex_doc/formatter/html_test.exs

@@ -602,7 +602,6 @@ defmodule ExDoc.Formatter.HTMLTest do
                %{
                  anchor: "heading-without-content",
                  title: "custom-text",
-                 description: "Some Custom Text",
                  type: "custom",
                  body: """
                  Some longer text!
@@ -621,7 +620,6 @@ defmodule ExDoc.Formatter.HTMLTest do
                %{
                  "anchor" => "heading-without-content",
                  "id" => "custom-text",
-                 "description" => "Some Custom Text",
                  "labels" => ["custom"]
                }
              ] =