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

Add noRd to the code #3368

Merged
merged 1 commit into from
Sep 2, 2024
Merged

Conversation

sambhavnoobcoder
Copy link
Contributor

  • quick fix to omit rd files out of the total roxygen code

Description

Added @noRd tag to the .create_folds function to prevent generation of Rd file for this internal function.

Motivation and Context

This change is required to prevent the generation of unnecessary Rd files for internal functions, which aligns with the project's documentation practices. It addresses the issue of Rd files being generated for non-exported functions.

Review Time Estimate

  • Immediately
  • Within one week
  • When possible

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • My name is in the list of CITATION.cff
  • I have updated the CHANGELOG.md.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

- quick fix to omit rd files out of the total roxygen code
@mdietze mdietze merged commit 72e67a9 into PecanProject:develop Sep 2, 2024
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants