devtools::check() produced warnings

[Robinlovelace]

When running the following command inside the root directory

devtools::check()

I get the following warnings:

prepare_Rd: man/ic_event.Rd:32: unknown macro '\item'
prepare_Rd: man/ic_event.Rd:34: unknown macro '\item'
prepare_Rd: man/ic_event.Rd:37: unknown macro '\item'
prepare_Rd: man/ic_event.Rd:41: unexpected section header '\value'
prepare_Rd: man/ic_event.Rd:44: unexpected section header '\description'
prepare_Rd: man/ic_event.Rd:47: unexpected section header '\examples'
prepare_Rd: man/ic_event.Rd:56: unexpected END_OF_INPUT '
'
checkRd: (5) ic_event.Rd:0-57: Must have a \description
* checking Rd metadata ... OK
* checking Rd line widths ... OK
* checking Rd cross-references ... OK
* checking for missing documentation entries ... OK
* checking for code/documentation mismatches ... OK
* checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'ic_event'
  ‘summary’ ‘more_properties’ ‘event_properties’

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.
* checking Rd contents ... OK
* checking for unstated dependencies in examples ... OK
* checking contents of ‘data’ directory ... OK
* checking data for non-ASCII characters ... OK
* checking LazyData ... OK
* checking data for ASCII and uncompressed saves ... OK
* checking installed files from ‘inst/doc’ ... OK
* checking files in ‘vignettes’ ... OK
* checking examples ... OK
* checking for unstated dependencies in ‘tests’ ... OK
* checking tests ...
  Running ‘testthat.R’
 OK
* checking for unstated dependencies in vignettes ... OK
* checking package vignettes in ‘inst/doc’ ... OK
* checking re-building of vignette outputs ... OK
* checking for non-standard things in the check directory ... OK
* checking for detritus in the temp directory ... OK
* DONE

Status: 3 WARNINGs
See
  ‘/tmp/RtmpQemFg1/calendar.Rcheck/00check.log’
for details.


── R CMD check results ──────────────────────────────────────────────────────── calendar 0.0.2 ────
Duration: 16s

❯ checking whether package ‘calendar’ can be installed ... WARNING
  See below...

❯ checking Rd files ... WARNING
  prepare_Rd: man/ic_event.Rd:32: unknown macro '\item'
  prepare_Rd: man/ic_event.Rd:34: unknown macro '\item'
  prepare_Rd: man/ic_event.Rd:37: unknown macro '\item'
  prepare_Rd: man/ic_event.Rd:41: unexpected section header '\value'
  prepare_Rd: man/ic_event.Rd:44: unexpected section header '\description'
  prepare_Rd: man/ic_event.Rd:47: unexpected section header '\examples'
  prepare_Rd: man/ic_event.Rd:56: unexpected END_OF_INPUT '
  '
  checkRd: (5) ic_event.Rd:0-57: Must have a \description

❯ checking Rd \usage sections ... WARNING
  Undocumented arguments in documentation object 'ic_event'
    ‘summary’ ‘more_properties’ ‘event_properties’
  
  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.

0 errors ✔ | 3 warnings ✖ | 0 notes ✔

Any ideas how to fix this @layik or @ConorIA ? Thanks for reviving the package Conor, committed to releasing the latest version on CRAN!

Also feel free to add a PR adding you as a package contributor, it's greatly appreciated.

[layik]

Hey Robin and @ConorIA. I might have touched this in the layik branch. I remember the item warnings/errors. Sorry but it has to wait if I were to look into it.

[layik]

👍 from me too on the review/contribution.