Undocumented objects causing build to issue warnings
russellpierce opened this issue · comments
Russell S. Pierce commented
* checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'get_session_token'
‘externalid’
Duplicated \argument entries in documentation object 'get_session_token':
‘policy’
Duplicated \argument entries in documentation object 'get_account':
‘...’
Undocumented arguments in documentation object 'create_group'
‘user’ ‘prefix’
Undocumented arguments in documentation object 'iamHTTP'
‘...’
Documented arguments not in \usage in documentation object 'iamHTTP':
‘dots’
Undocumented arguments in documentation object 'create_profile'
‘profile’ ‘path’ ‘...’ ‘role’ ‘n’ ‘marker’ ‘prefix’
Undocumented arguments in documentation object 'create_login'
‘user’ ‘password’ ‘reset’ ‘...’
Undocumented arguments in documentation object 'change_pwd'
‘requirements’
Documented arguments not in \usage in documentation object 'change_pwd':
‘require’
Documented arguments not in \usage in documentation object 'add_policy':
‘path’
Undocumented arguments in documentation object 'create_role'
‘profile’
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.
It is easy enough to add documentation where it is missing and remove it where it is duplicative. However, doing it accurately may be a bit more rough without actually using the package a bit. Is anybody working on this right now or should I think about giving it a stab?
Thomas J. Leeper commented
I would gladly accept a PR to correct these. Some of them are just typographical errors that should be easy to fix.
Thomas J. Leeper commented
I am pushing a fix for this momentarily.