Vignettes: adding info on relative path and encoding #31
Conversation
| @@ -37,6 +39,8 @@ This turns off the request recording or mocking and cleans up the R session stat | |||
|
|
|||
| Note that these code chunks have `include=FALSE`. This prevents them from being printed in the resulting Markdown, HTML, PDF, or whatever format document you produce. They're doing work behind the scenes, so you don't need them to be shown to your readers. | |||
|
|
|||
| When your requests have been recorded and saved as a sub-folder that corresponds to your `vignette-name` in the vignettes directory, they will be used for all subsequent runs of the vignette. However, it's always assumed that the stored files are encoded in utf-8. If your files have a different encoding, you may need to change this manually to utf-8 for httptest to work properly. | |||
There was a problem hiding this comment.
I'm not sure about this. It sounds like you're describing a bug that should be addressed, not something to document.
FWIW looking at the source for save_response(), I don't see how you can get anything that isn't UTF-8 or plain ASCII, so I'd be interested to see a minimal reprex.
There was a problem hiding this comment.
I definitely see your point. I have some example code where I reproducibly run into the exact same issue on a win10 computer. As I currently don't have access to linux/mac machines, i'm not entirely sure if this leads to the same problem. I'll try to verify that and come back to you.
|
Circling back here, apologies for the delay. On the first point about the vignette working directory, I wonder if something like #52 would help: if there is a "vignettes" subdirectory (perhaps with a vignette .Rmd matching the name given to On the encoding issues, we wrestled with Windows env stuff when porting the CI to GitHub Actions in #37, so there is now more "srsly, use UTF-8 everywhere" code. Can you retry your example and see if it is still a problem? |
|
I believe #55 should have resolved this. Please reopen if you find otherwise. Thanks again for your contribution here, even though we're not merging this PR. |
This expands the "Vignettes" vignette slightly to enhance the package documentation regarding specifities related to the working directory that has to be used when recording requests and requirements for the file encoding.
Both topics are currently only indirectly mentioned (working directory) or not mentioned (encoding) in the package documentation, but might be potentially helpful for other users.
Any feedback is welcome.