search

OceanParcels / Parcels

Main code for Parcels (Probably A Really Computationally Efficient Lagrangian Simulator)
https://www.oceanparcels.org
MIT License
294 stars 135 forks source link

`parcels_get_examples` deprecation notice #1376

Closed VeckoTheGecko closed 1 year ago

VeckoTheGecko commented 1 year ago

I only realised post release that replacing parcels_get_examples with a deprecation notice would probably be a better user experience than outright removing the command. Something like:

$ parcels_get_examples parcels_examples
The parcels_get_examples command has been deprecated since parcels v2.4.2. Notebooks are now
standalone as they download data on the fly. Please see the latest Parcels documentation for the
updated notebooks and instructions on how to download them.

https://docs.oceanparcels.org/en/latest/documentation.html

Thoughts?

erikvansebille commented 1 year ago

This is an interesting idea @VeckoTheGecko, but I don't think that many users regularly call this command. Only upon installation, but then they will follow the installation guide, where reference to parcels_get_examples is now gone. Also, providing this message would require yet another release before users would see it?

VeckoTheGecko commented 1 year ago

Yes it would require another release (and perhaps a withdrawl of 2.4.2 if we really want to be thorough). I don't think its worth it, and I think the updated docs are sufficient.