Display tooltip content as html (#1685)

Closes #1639
elixir-lang · Mar 24, 2023 · 5ec6735 · 5ec6735
1 parent f71fbc2
commit 5ec6735
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/assets/js/handlebars/templates/tooltip-body.handlebars b/assets/js/handlebars/templates/tooltip-body.handlebars
@@ -11,7 +11,7 @@
   </div>
   {{#if this.hint.description}}
     <section class="docstring">
-      {{this.hint.description}}
+      {{{this.hint.description}}}
     </section>
   {{/if}}
 {{/if}}
diff --git a/assets/js/tooltips/hints.js b/assets/js/tooltips/hints.js
@@ -154,7 +154,7 @@ export function extractFunctionHint (element) {
   const title = heading.textContent
 
   const firstParagraph = element.querySelector('.docstring > p')
-  const description = firstParagraph ? firstParagraph.textContent : ''
+  const description = firstParagraph ? firstParagraph.innerHTML : ''
 
   return {
     kind: HINT_KIND.function,
@@ -174,7 +174,7 @@ export function extractModuleHint (content) {
   const title = heading.textContent
 
   const firstParagraph = content.querySelector('#moduledoc p')
-  const description = firstParagraph ? firstParagraph.textContent : ''
+  const description = firstParagraph ? firstParagraph.innerHTML : ''
 
   return {
     kind: HINT_KIND.module,

diff --git a/assets/test/tooltips/hints.spec.js b/assets/test/tooltips/hints.spec.js
@@ -28,7 +28,7 @@ describe('hints extraction', () => {
 
     it('extracts hint info', () => {
       expect(extractModuleHint(modulePageObject).title).to.eql('Some module')
-      expect(extractModuleHint(modulePageObject).description).to.eql('Module description here')
+      expect(extractModuleHint(modulePageObject).description).to.eql('Module <strong>description</strong> here')
       expect(extractModuleHint(modulePageObject).kind).to.eql('module')
     })
   })