search

swirldev / swirl_courses

:mortar_board: A collection of interactive courses for the swirl R package.
http://swirlstats.com
Other
4.32k stars 7.24k forks source link

use of head() typo #377

Closed davidplans closed 7 years ago

davidplans commented 7 years ago

Around 56% into Looking at Data, where it says "Use head() to preview the first 10 rows" should read "Use head(plants, 10) to preview the first 10 rows"

seankross commented 7 years ago

I'd like to assume that students can figure this one out on their own.

davidplans commented 7 years ago

Fair enough of course (I did) but this is a sentence form you use a lot (propose a new concept then directly instruct the user how to type it out to see result). In this one you do the same: if you then expect the user to figure it out, it will create unexpected cognitive dissonance. Perhaps the second half of the sentence should ask a question as oppose to offer an instruction? As it is, your instruction, if followed as written, just fails (but there's no clue that you're being 'tested').

Another options would be to reward the user for figuring out that you have the wrong (or incomplete) instruction.

Just a thought. On Fri, 22 Sep 2017 at 17:53, Sean Kross notifications@github.com wrote:

I'd like to assume that students can figure this one out on their own.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/swirldev/swirl_courses/pull/377#issuecomment-331501260, or mute the thread https://github.com/notifications/unsubscribe-auth/ABIFQbqrNKwkIfcKwCWalj1oXuE5vJolks5sk-YAgaJpZM4Pg3uL .

seankross commented 7 years ago

Oh I see what you're saying, it could say something like "use head() with the appropriate arguments..."

davidplans commented 7 years ago

Yes that's exactly what I mean: either let's invite the student to guess, or be clear that they don't need to?

seankross commented 7 years ago

I'll come back to this soon when I add some other major revisions to the content.

davidplans commented 7 years ago

Cool! Are you happy for me to report others like this one in this way? I’m having my students and R group use swirl and I’d love to iron out niggles before they get stuck in, as I LOVE swirl’s dynamic On Thu, 28 Sep 2017 at 22:28, Sean Kross notifications@github.com wrote:

I'll come back to this soon when I add some other major revisions to the content.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/swirldev/swirl_courses/pull/377#issuecomment-332969082, or mute the thread https://github.com/notifications/unsubscribe-auth/ABIFQRt8FgQ3QQ3nYePEb1Kph5Wiczm0ks5snA-IgaJpZM4Pg3uL .

seankross commented 7 years ago

@davidplans, oh wow, interesting. I would appreciate that! In general I would be happy to accept PRs with wording that you think is better, according to some guidelines. Taking this case as an example if you sent a PR with language like "use head() with the appropriate arguments" I'd be happy to merge it. If you're willing to work with me on this I would be a big help to me and the swirl community!