Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not-ASCII does not work for documentation #5

Open
MurielleDelmotte opened this issue May 27, 2020 · 3 comments
Open

Not-ASCII does not work for documentation #5

MurielleDelmotte opened this issue May 27, 2020 · 3 comments

Comments

@MurielleDelmotte
Copy link

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

@pvictor
Copy link
Member

pvictor commented May 27, 2020

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
Copy link
Author

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
Copy link
Member

pvictor commented May 28, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants