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

Deprecate the "local" argument in CivisFuture() #247

Merged
merged 19 commits into from
Feb 13, 2023

Conversation

pcooman
Copy link

@pcooman pcooman commented Feb 10, 2023

This PR address issue #244:

  • updates the DESCRIPTION file:
    • increments the version tag to v3.0.1 (patch from v.3.0.0)
    • replaces Patrick Miller with @pcooman as the maintainer of the civis package
    • adds the lifecycle package as a dependency (to warn users of the new deprecated argument)
  • in civis_future.R:
    • sets the local argument to be deprecated (+ in documentation)
    • raises a warning if a local argument is supplied
    • removes the deprecated local argument from future::Future()
  • in scripts.R
    • removes @inheritParams fetch_output_file_ids. All arguments for fetch_output were already present, so this was raining a warning when building the Roxygen2 documentation.
  • in civis_ml.R
    • I split the documentation for x, newdata, Because the documentation for x was not getting properly inherited into the documentation of the CivisML functions (this was causing an R CMD CHECK warning)
  • updates all documentation (generated using Roxygen2 v7.2.2, up from v7.1.0)
  • (almost) all files in the man folder were generated when I re-generated the default client (use run_generate_client.R in the tools directory)
  • updates the CHANGELOG

@pcooman pcooman marked this pull request as draft February 10, 2023 21:14
@pcooman pcooman marked this pull request as ready for review February 10, 2023 21:37
DESCRIPTION Outdated
@@ -1,8 +1,9 @@
Package: civis
Title: R Client for the 'Civis Platform API'
Version: 3.0.0
Version: 3.0.1
Copy link
Member

Choose a reason for hiding this comment

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

I think this change is worth a minor version bump https://semver.org/

Copy link
Author

Choose a reason for hiding this comment

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

done!

@pcooman pcooman changed the base branch from master to prep_release_v3.1.0 February 13, 2023 16:26
@@ -2,6 +2,9 @@

## Unreleased
Copy link
Contributor

Choose a reason for hiding this comment

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

If you're bumping the version number in DESCRIPTION, I think you should add a [3.1.0] section here in the changelog also. Other than that, looks good

Copy link
Author

Choose a reason for hiding this comment

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

done!

@pcooman pcooman merged commit 5673d54 into prep_release_v3.1.0 Feb 13, 2023
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.

None yet

3 participants