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

Alpha testing feedback #35

Open
caifand opened this issue May 31, 2021 · 2 comments
Open

Alpha testing feedback #35

caifand opened this issue May 31, 2021 · 2 comments
Assignees
Labels
Alpha Testing This PR is associated with the Alpha Test of the new lesson template (codename: Buoyant Barnacle) Windows This issue contains elements specific to Windows

Comments

@caifand
Copy link

caifand commented May 31, 2021

Hi,

Thanks for creating the package and inviting me to test it. I indeed like it and look forward to using it for my own lesson. To be clear I am an R Studio user, so I feel the process is very intuitive to me. Besides, the current documentation reads great and entertaining :)

I haven't encountered major holdbacks. Just note several minor points here in case I forget them:

  • When creating the nested callouts, it seems that a newline is needed between the inner and outer callouts. Otherwise the creation would fail. I am not sure if it has anything to do with my environment. I am working on the newest version of R Studio on Windows 10. If it is a thing that everyone needs to look out for, perhaps it would be something to be specified in documentation?

  • It is very cool to enable the emoji in the template. I assume it follows the GitHub Markdown syntax so they can be properly rendered on GitHub Page. But I am not able to get correctly rendered emojis from my local disk. So it may create confusion when users are trying to preview their lessons in the local environment. Again, not sure if it has anything to do with my OS or other environmental elements

  • I also have something rendered not super neatly from my local, reasons unknown:
    image

  • It might be good to accompany the screenshots in the Setup chapter with alt text as well. If that would be desired I can help with that edit.

Happy to chat more if these are not clear enough :)

@zkamvar zkamvar added the Alpha Testing This PR is associated with the Alpha Test of the new lesson template (codename: Buoyant Barnacle) label May 31, 2021
@zkamvar zkamvar self-assigned this May 31, 2021
@zkamvar
Copy link
Contributor

zkamvar commented Jun 1, 2021

Thank you for being so detailed in your feedback. I can confirm that Windows machines set to different locales will not display emoji correctly and will work towards figuring out if there is a fix for that.

Update. This is an issue with Windows code pages creating mojibake locally (the screenshot below was captured using codepage 949). This is in part because there are historical problems supporting UTF-8 locales on Windows in R (see https://developer.r-project.org/Blog/public/2020/07/30/windows/utf-8-build-of-r-and-cran-packages/index.html)

screencapture showing an apostrophe and three emojis that should render as grin, 100, and tada, respectively rendering as Korean syllables

This image was adapted from the following markdown (with most of the prose removed) to highlight the issue

https://github.com/zkamvar/sandpaper-docs/blob/4a62a86230eb51730cc3b6b12d39b01b7c3529da/episodes/episodes.Rmd#L231-L245

@zkamvar zkamvar added the Windows This issue contains elements specific to Windows label Jun 1, 2021
@zkamvar
Copy link
Contributor

zkamvar commented Aug 25, 2022

I just realised that I never updated this: R 4.2.0 on Windows now has native UTF-8 support 🎉, so this issue should no longer be a problem for folks with this version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Alpha Testing This PR is associated with the Alpha Test of the new lesson template (codename: Buoyant Barnacle) Windows This issue contains elements specific to Windows
Projects
None yet
Development

No branches or pull requests

2 participants