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

Closes #244 #251 reduces cyclomatic complexity and cleanup of .lintr #254

Merged
merged 15 commits into from
Mar 4, 2024

Conversation

averissimo
Copy link
Collaborator

@averissimo averissimo commented Feb 29, 2024

Changes Description

  • Reduces complexity of xportr_length and xportr_format to below linter default threshold
  • Reinstates linter rules:
    • object_name_linter: snake_case with exception of _xportr.attr_name_ attributes and ADaM uppercase variables (ADSL).

Task List

  • The spirit of xportr is met in your Pull Request
  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Summary of changes filled out in the above Changes Description. Can be removed or left blank if changes are minor/self-explanatory.
  • Code is formatted according to the tidyverse style guide. Use styler package and functions to style files accordingly.
  • New functions or arguments follow established convention found in the Wiki.
  • Updated relevant unit tests or have written new unit tests. See our Wiki for conventions used in this package.
  • Creation/updated relevant roxygen headers and examples. See our Wiki for conventions used in this package.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Run pkgdown::build_site() and check that all affected examples are displayed correctly and that all new/updated functions occur on the "Reference" page.
  • Update NEWS.md if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
  • The NEWS.md entry should go under the # xportr development version section. Don't worry about updating the version because it will be auto-updated using the vbump.yaml CI.
  • Address any updates needed for vignettes and/or templates.
  • Link the issue Development Panel so that it closes after successful merging.
  • The developer is responsible for fixing merge conflicts not the Reviewer.
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@averissimo averissimo added the enhancement New feature or request label Feb 29, 2024
Copy link

github-actions bot commented Feb 29, 2024

Code Coverage

Package Line Rate Health
xportr 100%
Summary 100% (785 / 785)

R/length.R Show resolved Hide resolved
R/type.R Show resolved Hide resolved
R/length.R Show resolved Hide resolved
@averissimo averissimo changed the title Close #244 #251 reduces cyclomatic complexity and cleanup of .lintr Closes #244 #251 reduces cyclomatic complexity and cleanup of .lintr Mar 1, 2024
Copy link
Collaborator

@cpiraux cpiraux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for implementing this! I've reviewed the changes made to format.R and length.R, and everything looks good to me

Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @averissimo for helping clean up our code!! Looks very nice!

@bms63 bms63 merged commit 1bb339a into main Mar 4, 2024
15 checks passed
@bms63 bms63 deleted the 244-complexity branch March 4, 2024 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reduce cyclomatic complexity of xportr_format() Reduce cyclomatic complexity
4 participants