redhat-developer / redhat-developer/vscode-yaml

property description is not rendered the same, with completion and with hover

Open
#455 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
829
Forks
260
Avg merge
5h 43m
Merged PRs (30d)
1

Description

Describe the bug

Given that I have this property description:

"description": "With the equals condition, you can compare if a field has a certain value. The condition accepts only an integer or a string value.\n\nFor example, the following condition checks if the response code of the HTTP transaction is 200:\n\nequals:\n  http.response.code: 200"

When I use property completion to display description, I get this:
image

When I use property hover to display description, I get this:
image

So this would be great if rendering was the same for both cases.
And it would be great that the common rendering is actual "property completion" rendering, that is more precise.

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 reproducing the issue with the property description shown in the report, then compare the property-completion and property-hover rendering entry points. The work is done when both views render the description identically, using the more precise completion formatting, with the relevant behavior covered by a test if the existing test structure allows it.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
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.