@slot tag generating check error

[imanuelcostigan]

Code block

draw.Blob <- function (type = 'small') 
{
  'Something about blobs'
  type <<- 'small'
}

#' Blob
#'
#' Blah blah blah
#' 
#' @slot type a character vector
#' @examples
#' Blob(type = 'small')
#' @export
Blob <- setRefClass (
  Class = "Blob", 
  fields = list(type = 'character'),
  methods = list(draw = draw.Blob)
)

check() generates following error message:

* checking for code/documentation mismatches ... WARNING
S4 class codoc mismatches from documentation object 'Blob-class':
Slots for class 'Blob'
  Code: .xData
  Inherited: .xData
  Docs: type

If I remove the roxygen line starting with @slot this error message goes away.

Reproducible example on the slot_issues branch of roxygentest repo

Perhaps useful throwaway comment here:

Also @field tag for RC a la @slot for S4

[hadley]

If you can figure out how to make the Rd file correct, could you please include here?

[imanuelcostigan]

Rd file generated by roxygen looks like this:

\section{Slots}{

\describe{
\item{\code{type}}{a character vector}
}}

Changing first line to \section{Fields} solved the problem.

[hadley]

Grrr. At least it's an easy fix.