Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

QLDoc view omits `<code>` HTML elements

Ouverte
#794 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
35/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
typescript
Domaine
documentation

Piste de recherche

Reproduisez le problème dans un fichier de requête en survolant l’exemple QLDoc fourni dans l’extension VSCode. Suivez le chemin de survol/rendu de QLDoc pour déterminer pourquoi le contenu des éléments code est omis. Le travail est terminé lorsque le contenu apparaît dans le QLDoc rendu, idéalement avec un formatage du code, sans régression pour les autres éléments HTML affichés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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. <b>bold</b>).

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

  1. In a query file write the following QLDoc comment or add it to an existing element 
    /**
 * Test <code>code</code> &ast;/ <b>bold</b> <i>italic</i>
 */
  2. 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 <b>)
  • 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

Langage dominant
TypeScript
Étoiles
539
Forks
240
Merge moyen
2 j 18 h
PR mergées (30 j)
37

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de github/vscode-codeql

Toutes les issues de github/vscode-codeql

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.