dreamRs / prefixer

Prefix function with their namespace & other development tools
GNU General Public License v3.0
142 stars 5 forks source link

Not-ASCII does not work for documentation #5

Open MurielleDelmotte opened 4 years ago

MurielleDelmotte commented 4 years ago

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

pvictor commented 4 years ago

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

MurielleDelmotte commented 4 years ago

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 ....

pvictor commented 4 years ago

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

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

Victor