Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider optionally writing desc into comment via {glue} syntax #10

Open
arthur-shaw opened this issue Oct 1, 2023 · 0 comments
Open

Comments

@arthur-shaw
Copy link
Owner

Often, issue comments consist of a short summary, like the one provided in desc, followed by a longer description and instructions on remediation. To minmize needless repetition, consider allowing the contents of desc to be available in comment via {glue}. For example:

susoreview::create_issue(
df = attribs,
vars = "var1",
where = var1 == 0,
type = 1,
desc = "Short description of issue",
comment = "ERROR: {desc}. Longer issue description. Instructions on what to do."
)

See code here.

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

No branches or pull requests

1 participant