redhat-developer / redhat-developer/vscode-xml

Is there any way to break lines in attribute hover text?

Open
#310 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hello, I need to several sections in the hover help text when hovering an XML attribute (options attribute in this example below). I am generating the help text with "documentation" tag, and I tried to add "#xD#xA" and "
" and none of them can break lines in hover text. Is there any way to do this?

<xs:attribute name="options" type="xs:string" use="required">
                <xs:annotation>
                    <xs:documentation xml:lang="en">
                        Array of checkbox which needs to be displayed as part of the checkbox group.
                        #xD#xA
                        Value shape: blablaba
                    </xs:documentation>
                </xs:annotation>
            </xs:attribute>

image

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

The issue provides an XML Schema example using xs:documentation on an attribute and asks about line breaks in the hover help text. Start by locating the XML attribute-hover rendering entry point and its existing tests; done means documented multiline content is displayed with visible line breaks, with coverage for the provided example.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.