REditorSupport / REditorSupport/vscode-R

Recognize roxygen single line comment characters #' in toggle comment commands

Open
#85 2 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request help wanted
Dominant language
TypeScript
Stars
1.2k
Forks
139
Avg merge
2h 46m
Merged PRs (30d)
5

Description

  • VSCode Version: 1.26.1
  • VSCode-R Version: 0.6.1
  • OS Version: OS X 10.13.6

Steps to Reproduce:

  1. In any R file add new line with #' test roxygen comment
  2. Toggle line comment
    • expected: test,
    • got: ' test
  3. Toggle line comment
    • expected: # test or #' test
    • got: # ' test

Reg. the last point, it would be actually superb to have a separate command: Toggle roxygen line comment.

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

Reproduce the toggle line comment commands in an R file using a roxygen #' test comment, then trace the VSCode-R command entry point that handles comment characters. Done means toggling produces the expected roxygen-aware comment text, with the requested separate command treated as a distinct scope if needed.

Written by the indexing model from the issue text.

Assessment

Tech stack
r, typescript, vscode
Domain
developer-experience, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.