Skip to content

Conversation

@brookslogan
Copy link
Contributor

@brookslogan brookslogan commented May 28, 2025

so that following in order will \style roxygen @examples and then /document will propagate styled examples to the .Rd files, rather than leaving .Rd files out of date.

Checklist

Please:

  • Make sure this PR is against "dev", not "main" (unless this is a release
    PR).
  • Request a review from one of the current main reviewers:
    brookslogan, nmdefries.
  • Makes sure to bump the version number in DESCRIPTION. Always increment
    the patch version number (the third number), unless you are making a
    release PR from dev to main, in which case increment the minor version
    number (the second number).
  • Describe changes made in NEWS.md, making sure breaking changes
    (backwards-incompatible changes to the documented interface) are noted.
    Collect the changes under the next release number (e.g. if you are on
    1.7.2, then write your changes under the 1.8 heading).
  • Styling and documentation checks. Make a PR comment with:
    • /document to check the package documentation and fix any issues.
    • /style to check the style and fix any issues.
    • /preview-docs to preview the docs.
    • See Actions GitHub tab to track progress of these commands.
  • See DEVELOPMENT.md for more information on the development
    process.

Change explanations for reviewer

Magic GitHub syntax to mark associated Issue(s) as resolved when this is merged into the default branch

  • Resolves #{issue number}

so that following in order will style roxygen `@examples` and /doc will propagate styled examples to the .Rd files, rather than leaving .Rd files out of date.
@brookslogan brookslogan changed the title List /style before /doc in PR template List /style before /document in PR template May 28, 2025
@brookslogan
Copy link
Contributor Author

This seems relatively straightforward and minor, just going to merge without the dressings and review.

@brookslogan brookslogan merged commit 11bcfec into dev May 28, 2025
3 checks passed
@dshemetov dshemetov deleted the lcb/pr-template-style-doc-ordering branch May 28, 2025 19:34
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.

2 participants