Skip to content

ReferenceClass method documentation generates error for parameterised methods #180

@imanuelcostigan

Description

@imanuelcostigan

I have a reference class, say Blob, that has some methods defined by a function elsewhere. This function has one argument, say type.

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

Blob <- setRefClass (
  Class = "Blob", 
  fields = list(type = 'character'),
  methods = list(draw = draw.Blob)
)

When running document(clean=TRUE) and then check_doc(), I get the following error:

> check_doc()
Updating packageName documentation
Checking documentation
Blob-class.Rd: non-ASCII input and no declared encoding
problem found in ‘Blob-class.Rd’

When I delete the type parameter from draw.Blob, the error message goes away. There are no obvious issues with the Rd file that was generated - and certainly no obvious (visible) non ASCII characters in the Rd file.

Perhaps a separate issue is that when I change the draw.Blob docstring or even remove the function's parameter, and run document(), it doesn't pick up the change. When I run document(clean=TRUE) the change is picked up (unsurprisingly).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions