redhat-developer / redhat-developer/vscode-xml

XSD Documentation does not support newlines in markdown

Open
#951 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug xsd
Dominant language
TypeScript
Stars
328
Forks
101
Avg merge
1d 17h
Merged PRs (30d)
7

Description

Hoover toolitips from xs:documentation currently do not support newlines.
This breaks markdown features requiring newlines, which is really most of them, including headings and bullet lists.

The only way to obtain proper newlines is with multiple xs:documentation tags, which quickly becomes very verbose to do.

This works:

<xs:annotation>
    <xs:documentation>
        Il Tag è utilizzato per creare, sullo scope locale, dei contesti manipolati partendo da un contesto
        più generico già esistente.
        E' possibile utilizzare le seguenti tag per manipolare i contesti:
    </xs:documentation>
    <xs:documentation>
        - Where: Applica un filtro al contesto.
    </xs:documentation>
    <xs:documentation>
        - Take: Seleziona solo alcuni elementi di un contesto.
    </xs:documentation>
</xs:annotation>

image

The following unfortunately does not:

<xs:annotation>
  <xs:documentation> 
      Il Tag Context è utilizzato per creare, sullo scope locale, dei contesti manipolati partendo da un contesto
      più generico già esistente.
      
      E' possibile utilizzare le seguenti tag per manipolare i contesti:
      - Where: Applica un filtro al contesto.
      - Take: Seleziona solo alcuni elementi di un contesto.
  </xs:documentation>
</xs:annotation>

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the XSD xs:documentation handling in vscode-xml and reproduce the issue with the two XML examples in this report. The work is done when newlines within a single xs:documentation element are preserved so Markdown headings and bullet lists render correctly, while the existing multiple-element case continues to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, typescript, xml
Domain
devtools, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.