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

Update version to 0.99.992 and add internal keywords #89

Merged
merged 1 commit into from
Sep 22, 2024

Conversation

AliSajid
Copy link
Collaborator

@AliSajid AliSajid commented Sep 22, 2024

TL;DR

Updated package version and added internal keywords to utility functions.

What changed?

  • Incremented package version from 0.99.991 to 0.99.992 in DESCRIPTION and codemeta.json files.
  • Added @keywords internal to several utility functions in utilities.R:
    • .ilincsBaseUrl()
    • .validateLibrary()
    • validateLibraries()
    • stopIfInvalidLibraries()
    • loadMetadata()
    • .return_library()
  • Updated corresponding documentation files to include the internal keyword.

How to test?

  1. Check that the package version is correctly updated to 0.99.992.
  2. Verify that the internal functions are not exposed in the public API documentation.
  3. Ensure that the package builds and passes all existing tests without errors.

Why make this change?

The addition of @keywords internal to utility functions helps to clearly distinguish between public and internal API functions. This improves package organization and prevents users from directly accessing functions that are meant for internal use only. The version update reflects these changes and keeps the package versioning consistent.

Copy link
Collaborator Author

AliSajid commented Sep 22, 2024

@AliSajid AliSajid changed the title docs: mark all internal functions as such Update version to 0.99.992 and add internal keywords Sep 22, 2024
Copy link

graphite-app bot commented Sep 22, 2024

Graphite Automations

"Request reviewers once CI passes" took an action on this PR • (09/22/24)

3 reviewers were added to this PR based on Ali Sajid Imami's automation.

"Auto-assign PRs to author" took an action on this PR • (09/22/24)

1 assignee was added to this PR based on Ali Sajid Imami's automation.

Copy link
Collaborator Author

AliSajid commented Sep 22, 2024

Merge activity

  • Sep 22, 8:31 AM EDT: @AliSajid started a stack merge that includes this pull request via Graphite.
  • Sep 22, 8:31 AM EDT: @AliSajid merged this pull request with Graphite.

@AliSajid AliSajid merged commit f85b8e0 into devel Sep 22, 2024
5 checks passed
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.

1 participant