bcgov / bcgovr

An R package to automate set up and sharing of R projects in bcgov GitHub following bcgov guidelines
Apache License 2.0
34 stars 5 forks source link

Proper documentation for defunct `devex_badge()` function? #40

Closed stephhazlitt closed 6 years ago

stephhazlitt commented 6 years ago

We decided to skip deprecation/defunct documentation for the changes in bcgovr functions, given that bcgovr functionality is fully interactive, or is intended to be. With test driving, I have realized that we have devex_badge() scripted in almost every EnvReportBC repo.

Given this, and that perhaps others have used this function in the same way, I suggest we add in either a defunct error message, or keep devex_badge() with a deprecation message to now use insert_bcgov_devex_badge()?

ateucher commented 6 years ago

Oh good idea! I vote for the latter (still works with a deprecation message) to give ourselves a bit of time :)

stephhazlitt commented 6 years ago

I like time ⌛!

And still all OK with not adding defunct.R file, or should I just throw one in since we are on the path, and it is best practice and all?

stephhazlitt commented 6 years ago

bcgovr::devex_badge works again with deprecation warning. After reviewing the rest of the interactive functions—and :thinking: about it again—I don't think the defunct.R approach is necessary for the remainder of the renamed functions.

ateucher commented 6 years ago

Beautiful, thanks!