QLDoc view omits `<code>` HTML elements
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Bug
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- typescript
- Bereich
- documentation
Rechercherichtung
Reproduziere das Problem in einer Query-Datei, indem du im VSCode-Extension über das bereitgestellte QLDoc-Beispiel fährst. Verfolge den QLDoc-Hover-/Rendering-Pfad, um festzustellen, warum der Inhalt von code-Elementen ausgelassen wird. Als erledigt gilt die Aufgabe, wenn der Inhalt im gerenderten QLDoc erscheint, idealerweise mit Code-Formatierung, ohne dass die anderen angezeigten HTML-Elemente beeinträchtigt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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. *), 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:
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>/** ... */</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> */ <b>bold</b> <i>italic</i> */ - 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:
- Vorherrschende Sprache
- TypeScript
- Sterne
- 539
- Forks
- 240
- Ø Merge
- 2 T. 18 Std.
- Gemergte PRs (30 T.)
- 37
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus github/vscode-codeql
-
bug VSCode
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
github/vscode-codeql#4471 · 1 Kommentar ·
-
bug enhancement VSCode
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
github/vscode-codeql#592 · 2 Kommentare ·
-
enhancement VSCode
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
github/vscode-codeql#4432 · 1 Kommentar ·
-
bug VSCode
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 52/100
github/vscode-codeql#4356 ·
-
bug VSCode
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 64/100
github/vscode-codeql#4339 · 1 Kommentar ·
Alle Issues in github/vscode-codeql
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
-
bug v2
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
modelcontextprotocol/inspector#2458 · 1 Kommentar ·
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
carbon-design-system/ibm-products#9907 ·