ropensci / neotoma

Programmatic R interface to the Neotoma Paleoecological Database.
https://docs.ropensci.org/neotoma
Other
30 stars 16 forks source link

Added notice to the most recent version to identify the fact that backwa... #88

Closed SimonGoring closed 10 years ago

SimonGoring commented 10 years ago

...rd compatibility has been broken.

gavinsimpson commented 10 years ago

I know this hasn't been released to CRAN but good practice would be to follow the deprecation guidance and use the .Deprecated() functionality to indicate deprecated functions. Will certainly help transition people to the new names, especially if you've done training or workshops with the old function names.

Just a thought

SimonGoring commented 10 years ago

I didn't know about that! Thanks Gavin. I'll check it out and the probably push everything back up.

gavinsimpson commented 10 years ago

It's a little tedious as you are supposed to maintain some additional help pages etc (which I've never done with roxygen) to list deprecated (and later defunct) functions. Just weigh up effort needed to do this against potential gain/pain for existing users before you start.

SimonGoring commented 10 years ago

No, I think it's fine. It looks like I just need to make the old pages again, but add .Deprecated to them. Not sure what ROxygen's going to think, but I'll find out.

Thanks for the heads up!