REditorSupport / REditorSupport/languageserver

Roxygen comments soft linebreaks aren't ignored in languageserver hover hints

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

Nobody has claimed this yet.

Dominant language
R
Stars
675
Forks
118
Avg merge
1d 37m
Merged PRs (30d)
11

Description

Roxygen comments soft linebreaks aren't ignored in languageserver hover hints.

Basically, the issue was reported and explained in r-lib/roxygen2#628, and it was fixed by Roxygen.
However, R languageserver doesn't ignore these soft line breaks on function details hover.

Seems like a small fix, right?

Contributor guide

No contributing guide indexed for this repository

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

No source file or test is named. Start by reading the linked roxygen2#628 report and tracing how languageserver builds function-details hover hints for Roxygen comments. Reproduce the hover output with a soft linebreak, then verify that the rendered hint ignores that break.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.