Skip to content

Roxygen 7.0.0 escapes % character to \\\% instead to \% in S4methods documentation. #976

@lukasz-bednarz-reddeersystems

Description

The \S4Method{...} entries in objects.md will have tripple \\\% escape. This makes R CMD check generating errors on missing method documentations and issues with finding references for @inheritParams.

Details ``` library(roxygen2)

roc_proc_text(rd_roclet(), "
#' Operators for combining objects
#' @param x object of class derived from logical
#' @param y object of class derived from logical
#' @name operators
NULL
#' Combine
#'
#' @inheritParams operators
#'
#' @name intersection
#' @Rdname operators
#' @Aliases intersection_operator %&&%
#' @export
setGeneric('%&&%',
function(x, y){
standardGeneric('%&&%')
})
#' %&&% combine objects in an intersection
#'
#' @inheritParams operators
#' @Rdname operators
#' @Aliases intersection_operator %&&%
#' @export
setMethod('%&&%',
signature(x = 'logical',
y= 'logical'),
function(x, y){
object <- x && y
return(object)
}
)
")


# Roxygen 6.1.1


$operators.Rd
% Generated by roxygen2: do not edit by hand
% Please edit documentation in RtmpcDkoRi/file1b707fc45411
\docType{methods}
\name{operators}
\alias{operators}
\alias{intersection}
\alias{intersection_operator}
\alias{%&&%}
\alias{%&&%,logical,logical-method}
\title{Operators for combining objects}
\usage{
x %&&% y

\S4method{%&&%}{logical,logical}(x, y)
}
\arguments{
\item{x}{object of class derived from logical} \item{y}
{object of class derived from logical}
}
\description{
Operators for combining objects Combine %&&% combine objects
in an intersection
}


### R 7.0.0

$operators.Rd
% Generated by roxygen2: do not edit by hand
% Please edit documentation in ./
\name{operators}
\alias{operators}
\alias{intersection}
\alias{intersection_operator}
\alias{%&&%}
\alias{%&&%,logical,logical-method}
\title{Operators for combining objects}
\usage{
x %&&% y

\S4method{\%&&\%}{logical,logical}(x, y)
}
\arguments{
\item{x}{object of class derived from logical}

\item{y}{object of class derived from logical}
}
\description{
Operators for combining objects

Combine

%&&% combine objects in an intersection
}

Warning message:
Topic 'operators': no parameters to inherit with @inheritParams

  • Topic 'intersection': no parameters to inherit with @inheritParams
  • Topic '%&&%,logical,logical-method': no parameters to inherit with @inheritParams

<details>

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugan unexpected problem or unintended behaviorrd ✍️

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions