Skip to content

Conversation

ndjrt
Copy link

@ndjrt ndjrt commented Sep 19, 2025

Fixes #1862

@jennybc
Copy link
Member

jennybc commented Sep 19, 2025

Thanks @ndjrt! My first inclination is that we'd want to populate this programmatically, i.e. to actually hit the code that generates the checklist. This guarantees that the docs match the code. Now this is actually kind of hard/fiddly, which is why this hasn't been solved yet!

The technology you'd use to do this is here:

https://roxygen2.r-lib.org/articles/rd-formatting.html#code-chunks

It's still not simple, because you'd have to point at a fake package and/or call an unexported helper, both of which require some thought. So if you're interested in continuing the effort, that's what needs to be explored. It's possible that we decide this is more trouble than it's worth, but it would be interesting to take a crack at this and see how feasible it is. The tests related to upkeep are a great place to start for inspiration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Could the manual page of use_upkeep_issue show the checklist?
2 participants