Skip to content

Commit

Permalink
Merge branch 'main' into 466-deprecation-20
Browse files Browse the repository at this point in the history
  • Loading branch information
bms63 authored Jan 8, 2025
2 parents de54cd2 + f3b3aa2 commit 3578ff9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
8 changes: 7 additions & 1 deletion vignettes/programming_strategy.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 3578ff9

Please sign in to comment.