prefixer icon indicating copy to clipboard operation
prefixer copied to clipboard

Not-ASCII does not work for documentation

Open MurielleDelmotte opened this issue 4 years ago • 3 comments

Not-ASCII does not work for lines starting with #' (documentation of package) and # (comment). A possible evolution? :smiley:

MurielleDelmotte avatar May 27 '20 09:05 MurielleDelmotte

Hello,

Yes you can cannot use escaped characters in documentation, it's interpretated as rd macros... And in comments I don't think there's any benefit, they will be complicated to read and are not kept in the compiled code of a package.

I'm not sure since when, but it seems to work with special characters in documentation :

#' @title Sélection à être
#'
#' @description Caractères spéciaux éàç
#'
#' @param x Un paramètre
#'
#' @return un résultat
#' @export
#'
#' @examples
#' fonction(1)
fonction <- function(x) {
  x
}

image

What's your use case ?

Victor

pvictor avatar May 27 '20 12:05 pvictor

Thanks for the responsiveness! It is actually not useful in the comments. About the documentation, thank you for your answer, the problem is therefore that we work under windows ....

MurielleDelmotte avatar May 28 '20 05:05 MurielleDelmotte

I'm on Windows too, I've done nothing special and it works, I have:

  • RStudio Version 1.2.5033
  • R 3.6.3 with Rtools
  • roxygen2 7.1.0

You can try install this package : https://github.com/antuki/CARTElette Documentation is in french, maybe @antuki has more inputs on this.

Victor

pvictor avatar May 28 '20 08:05 pvictor