fatiando / community

Community resources, guidelines, meeting notes, authorship policy, maintenance, etc.
Other
8 stars 4 forks source link

Deprecate the "test" functions in our packages #44

Open leouieda opened 2 years ago

leouieda commented 2 years ago

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:

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 commented 2 years ago

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