posit-dev / posit-dev/ark

Diagnostic or Code Action that catches `#` nested within `#'`

Open
#810 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
337
Forks
32
Avg merge
8d 17h
Merged PRs (30d)
11

Description

From @EmilHvitfeldt

#' Title
#'
# @param ...
#'
#' @returns
#'
#' @export

Notice the # @param line missing the #'.

We can probably detect this by looking for # sandwiched directly between #'?

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 R documentation snippet in the issue and locate Ark's diagnostic and code-action entry points for R comments. Determine how a # line nested among #' lines is represented, then verify that the completed work reports or offers a fix for the missing #' without flagging valid comments.

Written by the indexing model from the issue text.

Assessment

Tech stack
r, rust
Domain
devtools
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.