@examples section messes up highlighting in roxygen2 blocks further down the page

[hadley]

Positron Version:

Steps to reproduce the issue:

cf https://github.com/r-lib/devtools/blob/main/R/package.R#L88

What did you expect to happen?

Looks like something further up the page leaves the parser in the wrong state.

Were there any error messages in the output or Developer Tools console?

[kevinushey]

Looks like this is caused by the #' @examples block above. A smaller reprex:

#' @examples
#' print(1 + 1)
NULL

#' Uh oh

Note that the text within the Roxygen documentation is being highlighted as though it were R code still.

[kevinushey]

Here's the offending code:

positron/extensions/positron-r/syntaxes/r.tmGrammar.src.json

Lines 427 to 436 in 8611f6e

	"begin": "(^\\s*#+')\\s*(@examples)\\s*$",
	"beginCaptures": {
	"1": { "name": "comment.line" },
	"2": { "name": "{{ roxygen-tag }}" }
	},
	"end": "(^\\s*#+')\\s*(@\\w*)",
	"endCaptures": {
	"1": { "name": "comment.line" },
	"2": { "name": "{{ roxygen-tag }}" }
	},

We need to improve how the "end" of an roxygen example code chunk ends.

[mine-cetinkaya-rundel]

Another instance of wrong highlighting in comments, not in roxygen comments but for comments followed by 4+ dashes:

[kevinushey]

That was intentional; the goal there is to help comment-style section titles stand out. Do you prefer the "plain" comment styling?

[mine-cetinkaya-rundel]

@kevinushey Having them stand out could be nice, but the color matching the default/code color doesn't make them stand out to me. I'd prefer either plain comment styling or using a different color (like a lighter green or something here) to have them stand out. Turning that text to black seems like it's not being interpreted as a comment.

[DavisVaughan]

Just hit this again for the docs of between() in dplyr

Screen.Recording.2024-08-27.at.11.25.18.AM.mov