diff --git a/DESCRIPTION b/DESCRIPTION index 2c0ebc62..1bf6fdc6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Type: Package Package: admiraldev Title: Utility Functions and Development Tools for the Admiral Package Family -Version: 1.1.0.9007 +Version: 1.1.0.9008 Authors@R: c( person("Ben", "Straub", , "ben.x.straub@gsk.com", role = c("aut", "cre")), person("Stefan", "Bundfuss", role = "aut", diff --git a/vignettes/programming_strategy.Rmd b/vignettes/programming_strategy.Rmd index 8dc43663..6afd0ffd 100644 --- a/vignettes/programming_strategy.Rmd +++ b/vignettes/programming_strategy.Rmd @@ -562,6 +562,7 @@ See [Writing Unit Tests in {admiral}](unit_test_guidance.html#writing-unit-tests The below deprecation strategy provides stability to users while allowing admiral developers the ability to remove and update the code base in the coming days. + - **Phase 1:** In the release where the identified function or argument is to be deprecated, there will be a message issued when using the function or argument using `deprecate_inform()`. This message will appear to the user for _one year_. The @@ -610,6 +611,7 @@ The documentation will be updated at Phase 2: #' @keywords deprecated ``` + Example for documentation at the argument level + the `@param` level for a argument. @@ -619,7 +621,6 @@ Example for documentation at the argument level ``` The documentation will be further updated at Phase 3: - + the `@examples` section should be removed. ## Handling of Messages, Warnings and Errors @@ -747,6 +748,11 @@ respectively. The unit-test should follow the corresponding format, per the TBD +### For Deprecated Functions that Issues a Warning (Phase 2) + +TBD + + ### For Deprecated Functions that Issues a Warning (Phase 2) A unit test like the following must be added.