What I have read
I have read this SO question and related answers but I am still a bit at loss of how to document a defunct
function properly in my package.
What I have tried
- I replaced the code of my
defunct
fucntion by a call of.Defunct("<pointer to a function to be used instead>", "<my package name>")
- I deleted the
.Rd
file containing the old documentation of my function - I created a
mypackage-defunct.Rd
file with an alias pointing to my nowdefunct
function name - In
mypackage-defunct.Rd
I created an\usage
entry for my old function and replaced the function arguments by\dots
(as I do not see the need to keep track about the old arguments. I followed a bit what is done in base-defunct)
What I have got
When running RCMD CHECK
I get the following WARNING
:
checking Rd \usage sections ... WARNING Undocumented arguments in documentation object 'mypackage-defunct' '...'
Functions with \usage entries need to have the appropriate \alias entries, and all their arguments documented. The \usage entries must correspond to syntactically valid R code. See chapter 'Writing R documentation files' in the 'Writing R Extensions' manual.
What I would like to have
How do i get rid of the warning? Do I need to document arguments from defunct
functions? Bonus question: What is the recommended way for a defunct function. Should I remove all arguments and replace them by ...
? Looking at base-defunct
, I see a mix of functions with proper argument names, .
and ...
arguments and empty argument lists. What is the "correct" way?
...
– Workbook