QLDoc view omits `<code>` HTML elements

Abierto

#794 abierto el 20/3/2021 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad: 3/5
Tiempo estimado: 1-2 días
Aptitud para principiantes: 35/100

Tipo de issue: Error
Claridad: Bastante claro
Estado de actividad: Estancado
Stack tecnológico: typescript
Área: documentation

Línea de trabajo

Reproduce el problema en un archivo de consulta pasando el cursor sobre el ejemplo de QLDoc proporcionado en la extensión de VSCode. Sigue la ruta de hover/renderizado de QLDoc para determinar por qué se omite el contenido de los elementos code. Se considera terminado cuando el contenido aparece en el QLDoc renderizado, idealmente con formato de código, sin introducir regresiones en los demás elementos HTML mostrados.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug VSCode

Describe the bug
According to the language specification QLDoc uses CommonMark, which supports raw HTML.

It appears that the VSCode extension supports HTML entity references (e.g. &ast;), and for some HTML elements simply shows their content without any special formatting (e.g. bold).

However, <code> elements are apparently completely omitted, not even their content is shown:
QLDoc VSCode extension screenshot

My use case is that I would like to write /** ... */ (a Javadoc comment) in a QLDoc, however */ is recognized as end of the QLDoc. Therefore the only workaround might be to use <code>/** ... &ast;/</code>.
But this is not super important, I could probably also just omit */ from my QLDoc comment.

To Reproduce

In a query file write the following QLDoc comment or add it to an existing element
```
/**
 * Test <code>code</code> &ast;/ bold italic
 */
```
Hover over the QLDoc
❌ The text "code" is completely missing from the shown rendered QLDoc

Expected behavior

At least the content of the <code> element should be shown in the rendered QLDoc (similar to how it is the case for )
Or ideally the content of the <code> element is shown and formatted as code

Additional context
The LGTM Query Console seems to support <code> and even formats the text as code in the preview when hovering over a documented element:
Query Console QLDoc screenshot