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

Introduce "reading help pages" in Episode 1 Intro to R #719

Open
ha0ye opened this issue May 14, 2021 · 2 comments
Open

Introduce "reading help pages" in Episode 1 Intro to R #719

ha0ye opened this issue May 14, 2021 · 2 comments
Labels
status:waiting for response Waiting for Contributor to respond to maintainers' comments or update PR type:enhancement Propose enhancement to the lesson

Comments

@ha0ye
Copy link
Contributor

ha0ye commented May 14, 2021

@katharinemarielee discussed the importance of being able to read technical documentation on twitter, and I realized this can be an important piece of information to facilitate self-learning by attendees after the workshop: https://twitter.com/ResourcefulSqrl/status/1393226321476603908

In Episode 1, the round() function is introduced, and there's a bit that goes over changing the default number of digits, and using ? to find the information.

It would be helpful to add some screenshots and description of navigating the documentation file and pull out important information:

  • which package the function is from
  • longer-form description
  • function arguments and default values
  • return value
  • examples

LMK if a PR would be welcome.

@Teebusch
Copy link
Contributor

Hi @ha0ye, that's a great suggestion! It's easy to forget how cryptic and overwhelming an R help page can be the first time you see one. Maybe a screenshot with some annotations as you suggest would be a good addition to the lesson?

@Teebusch Teebusch added status:waiting for response Waiting for Contributor to respond to maintainers' comments or update PR type:enhancement Propose enhancement to the lesson labels Jul 5, 2021
@tobyhodges
Copy link
Member

Thanks both for contributing to this discussion. The lesson underwent a major update and reorganisation when #887 was merged. Although this issue relates to content in a version of the lesson before that update took place, I think the suggestion remains relevant so I will leave it open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:waiting for response Waiting for Contributor to respond to maintainers' comments or update PR type:enhancement Propose enhancement to the lesson
Projects
None yet
Development

No branches or pull requests

3 participants