Document arguments in most functions

[judith-bourque]

Issue

── R CMD check results ────────────────────────────────────────────────────────────────────────────────────── hublot 1.6.0 ────
Duration: 6.2s

❯ checking Rd \usage sections ... WARNING
  Undocumented arguments in documentation object 'add_file'
    ‘id’ ‘body’ ‘credentials’
  
  Undocumented arguments in documentation object 'add_lake_item'
    ‘body’ ‘credentials’
  
# ...
  
  Undocumented arguments in documentation object 'update_tag'
    ‘id’ ‘body’ ‘credentials’
  
  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.

Proposed solution

• Reuse existing parameter description #69
• Document undocumented parameters #67
• Remove @export tag from not implemented functions #68

[judith-bourque]

Includes #39

[judith-bourque]

Should use @inheritParams ${1:source} with the function it depends on. It will only return parameters used.

[judith-bourque]

List of remaining undocumented parameters after reusing existing parameter descriptions (#69):

── R CMD check results ──────────────────────────────── hublot 1.6.9 ────
Duration: 9.5s

❯ checking Rd \usage sections ... WARNING
  Undocumented arguments in documentation object 'add_file'
    ‘id’ ‘body’ ‘credentials’
  
  Undocumented arguments in documentation object 'add_table_item'
    ‘table_name’
  
  Undocumented arguments in documentation object 'add_tag'
    ‘id’ ‘body’ ‘credentials’
  
  Undocumented arguments in documentation object 'batch_create_table_items'
    ‘table_name’
  
  Undocumented arguments in documentation object 'batch_delete_table_items'
    ‘table_name’
  
  Undocumented arguments in documentation object 'count_table_items'
    ‘table_name’ ‘credentials’ ‘filter’
  
  Undocumented arguments in documentation object 'filter_files'
    ‘filter’
  
  Undocumented arguments in documentation object 'filter_lake_items'
    ‘filter’
  
  Undocumented arguments in documentation object 'filter_table_items'
    ‘table_name’ ‘filter’
  
  Undocumented arguments in documentation object 'filter_tables'
    ‘filter’
  
  Undocumented arguments in documentation object 'filter_tags'
    ‘credentials’ ‘filter’
  
  Undocumented arguments in documentation object 'list_table_items'
    ‘table_name’
  
  Undocumented arguments in documentation object 'list_tags'
    ‘credentials’
  
  Undocumented arguments in documentation object 'log'
    ‘app_id’ ‘level’ ‘message’ ‘url’
  
  Undocumented arguments in documentation object 'remove_file'
    ‘id’ ‘credentials’
  
  Undocumented arguments in documentation object 'remove_lake_item'
    ‘id’
  
  Undocumented arguments in documentation object 'remove_table_item'
    ‘table_name’ ‘id’
  
  Undocumented arguments in documentation object 'remove_tag'
    ‘id’ ‘credentials’
  
  Undocumented arguments in documentation object 'retrieve_file'
    ‘id’
  
  Undocumented arguments in documentation object 'retrieve_journal'
    ‘id’
  
  Undocumented arguments in documentation object 'retrieve_lake_item'
    ‘id’
  
  Undocumented arguments in documentation object 'retrieve_log'
    ‘id’
  
  Undocumented arguments in documentation object 'retrieve_table_item'
    ‘table_name’ ‘id’
  
  Undocumented arguments in documentation object 'retrieve_tag'
    ‘id’ ‘credentials’
  
  Undocumented arguments in documentation object 'update_file'
    ‘id’ ‘body’ ‘credentials’
  
  Undocumented arguments in documentation object 'update_lake_item'
    ‘id’
  
  Undocumented arguments in documentation object 'update_table_item'
    ‘table_name’ ‘id’
  
  Undocumented arguments in documentation object 'update_tag'
    ‘id’ ‘body’ ‘credentials’