search

bluefoxr / COINr

COINr
https://bluefoxr.github.io/COINr/
Other
25 stars 7 forks source link

Add function deprecation notes in help pages #10

Closed bauer-alex closed 2 years ago

bauer-alex commented 2 years ago

Issue based on the JOSS revision process (see the corresponding issue).

The package contains a lot of exported functions which are deprecated. Printing the COINr:::defunct_message() when such functions are called seems like a good idea. Only thing I also would to see is a short deprecation note (can be identical to the defunct message) in the help page (e.g. ?COINr::getPCA) for full clarity.

bluefoxr commented 2 years ago

OK good point, I will do this.

bluefoxr commented 2 years ago

I have now added deprecation notes to all the relevant functions - see commit here: https://github.com/bluefoxr/COINr/commit/f98fc6df5a9fd08ce67caf11cc41f275fd8b8701

I'll close this issue now, because I presume it is fixed - if not, please open a separate issue or re-open. Thanks.