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 "test" functions in our packages #44

Open
2 of 4 tasks
leouieda opened this issue Dec 14, 2021 · 1 comment
Open
2 of 4 tasks

Deprecate the "test" functions in our packages #44

leouieda opened this issue Dec 14, 2021 · 1 comment
Labels
good first issue Good for newcomers

Comments

@leouieda
Copy link
Member

leouieda commented Dec 14, 2021

Description:

All our packages include a test function in their base __init__.py that was used as a way to test the version of the package that has actually been installed. But now they are not needed and hardly ever used since the same functionality can be achieved with pytest --pyargs PACKAGE_NAME.

We should deprecate these functions by including a FutureWarning when they are called. The functions would then be removed in the next major release or after 2 minor releases for packages pre-1.0.

See fatiando/verde#344 for a template.

Apply to:

Further instructions:

  • Start by opening Pull Requests on each repository listed above.
  • Optionally, we can open Issues on each repository if further discussion specific to that repository is needed.
  • Mention this Issue on every Issue or Pull Request opened on each opened: Related to fatiando/community#XX
  • Check-off the repository on the list above once the Pull Request is merged.
  • Close this issue when all items are checked-off.

We want your help!

We know that maintenance tasks are very demanding, so we don't expect a single person to tackle this issue by themselves. Any help is very welcomed, so please comment below that you want to take care of the changes on any repository and we will assign it to you.

@leouieda
Copy link
Member Author

Removing it outright in fatiando/boule#116 since this is such a minor thing that only devs should be using anyway.

santisoler added a commit to fatiando/harmonica that referenced this issue Mar 22, 2024
Remove the public `harmonica.test()` function. Also remove the section
in the Installing pages of the docs that instructed users to test their
installation.

Related to fatiando/community#44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant