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.

Sign up for GitHub

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

Jump to bottom

Is the requirement Encoding: UTF-8 at odds with WRE? #774

Closed
HughParsonage opened this issue Aug 8, 2018 · 1 comment
Closed

Is the requirement Encoding: UTF-8 at odds with WRE? #774

HughParsonage opened this issue Aug 8, 2018 · 1 comment

Comments

@HughParsonage
Copy link

I see since #649 the DESCRIPTION file must have Encoding: UTF-8. This seems sensible; however, I notice that in Writing R Extensions it says:

Do not specify an encoding unless one is actually needed: doing so makes the package less portable.

I'm reluctant to ignore warnings from roxygen2, but for my package the Encoding field is not "actually needed" and so I'm reluctant to add it. I don't know enough about encodings to suggest a fix.
@hadley
Copy link
Member

hadley commented Aug 21, 2018

Using Encoding: UTF-8 has not caused any problems for tidyverse packages.

@hadley hadley closed this as completed Aug 21, 2018
@bastistician bastistician mentioned this issue Sep 6, 2018
Closed
dschlaep added a commit to DrylandEcology/rSFSW2 that referenced this issue Mar 11, 2019
@dschlaep
Update DESCRIPTION: add encoding to meet roxygen2 >= v6.1.0
44efb8b 
- since r-lib/roxygen2#649 (`roxygen2` >= v6.1.0) warns if a `DESCRIPTION` file does not explicitly define its encoding as UTF-8
- this commits adds encoding information to the DESCRIPTION file even if it may be at odds with `Writing R Extensions` (https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Encoding-issues), but see r-lib/roxygen2#774

- at least, this works for me locally and eliminates the `roxygen2` warning "roxygen2 requires Encoding: UTF-8"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hadley @HughParsonage