doocument() backport_linter

[AshesITR]

backport_linter was missing documentation.

• added doc for argument r_version
• run document()

[MichaelChirico]

maybe we should add a GHA step to run document for us 😬

…

On Sun, Dec 6, 2020, 3:37 PM AshesITR ***@***.***> wrote: backport_linter was missing documentation. - added doc for argument r_version - run document() ------------------------------ You can view, comment on, or merge this pull request online at: #694 Commit Summary - doocument() backport_linter File Changes - *M* NAMESPACE <https://github.com/jimhester/lintr/pull/694/files#diff-b6b6854a02ae177f8860f49654ff250c1554d021ae434b6efdbe99d00bdc6055> (1) - *M* R/backport_linter.R <https://github.com/jimhester/lintr/pull/694/files#diff-d9fda7f98dcce6aa6890deb51d9c10138f58df2ba5ca6df007d45dc7f1e2d4e6> (1) - *M* man/default_linters.Rd <https://github.com/jimhester/lintr/pull/694/files#diff-e6d20fc6190453162629a94821e9b61ca9eac2bd4b22b6e237dd83a2da2fc727> (2) - *M* man/linters.Rd <https://github.com/jimhester/lintr/pull/694/files#diff-144347e1ba5441fcad23345066dfaff84cfd7d0378d99ac879833902229badce> (13) Patch Links: - https://github.com/jimhester/lintr/pull/694.patch - https://github.com/jimhester/lintr/pull/694.diff — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#694>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB2BA5OJMUYGVG6NYPVJ5NDSTPTRVANCNFSM4UPSTDLA> .

[AshesITR]

You mean a step that would on-push run devtools::document() and commit all changes?

[dragosmg]

@MichaelChirico @AshesITR usethis:use_github_action_pr_commands()? it adds this workflow which runs roxygen2::roxygenise().

[AshesITR]

That would require the author to remember to include /document (or /style) in the commit message.
Not sure how much benefit that provides compared to remember running devtools::document() and committing the resulting changes...

NB in the discussion around #584 we explicitly decided against using styler to do a bulk re-styling of the current codebase.

[MichaelChirico]

That would require the author to remember to include /document (or /style) in the commit message.

What I had in mind is the GHA runner doing it and pushing, no input needed. Probably just need to run this on push to master, otherwise there may be a permissions issue for getting PRs from forks.

[dragosmg]

@AshesITR @MichaelChirico I was thinking along the same lines - i.e. not use {styler} and look into configuring the workflow to automatically run (without a key word). I don't mind looking into it if still needed.

[AshesITR]

Sounds useful on PRs.
But we should be careful not to break builds accidentally.
document() on master without this pr (especially the @param r_version part) would have caused all builds to fail.

On the other hand, the original PR would have failed if the action was active.
That said, we'll probably need to only be very carefull when rolling this out.