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

Review requested: converted worksheets #2

Open
ghost opened this issue Sep 18, 2018 · 4 comments
Open

Review requested: converted worksheets #2

ghost opened this issue Sep 18, 2018 · 4 comments
Assignees

Comments

@ghost
Copy link

ghost commented Sep 18, 2018

Two example worksheets ready for review. I would appreciate feedback on how these look as READMEs rather than .odt documents. The first uses lots of screenshots (typical of the beginner worksheets) while the second uses markdown code blocks.

One thing that is lost by using markdown is the ability to show a chunk of existing code and highlighting new lines to be added to it. In the Eggs worksheet, for example, I have had to show a block of code and say "change the existing code so it matches this".

https://github.com/coder-dojo-ham/micropython_worksheets/tree/master/Beginner/01_say_hello
https://github.com/coder-dojo-ham/micropython_worksheets/tree/master/Advanced/03_eggs

@dannystaple
Copy link

For your lost highlighting new lines of code, depending on how the markdown md is being rendered - if it is github flavoured, "diff" type things can be done:

- print "stuff"
+ print("stuff")

That is acheived by using:

    ``` diff
     - line to remove
     + line to add
    ```

@dannystaple
Copy link

First Sheet

New terminology

This makes it a comment

I'd suggest putting a new term like "comment" in bold.

Other idea for added lines

Another alternative for new lines is to take the screenshots through a vector tool (like inkscape/draw.io) and place low opacity coloured boxes over them - so you get light green pastel overlay on added lines.

Eggs Sheet

I like the tip blocks you've created in this page. For the list comprehensions, is it worth explaining that it is a shorthand for a for loop here, but with some additional superpowers (ask the mentor about those)?

Mu buttons

I guess this is advanced, so are we safely able to assume that the student can find the new button and won't need the icon image?

Name/main

This is fairly standard boilerplate, great for unit testing and importing parts, but does this have context or is it explained for the student?

@ghost
Copy link
Author

ghost commented Sep 21, 2018

For your lost highlighting new lines of code, depending on how the markdown md is being rendered - if it is github flavoured, "diff" type things can be done:

- print "stuff"
+ print("stuff")

That is acheived by using:

    ``` diff
     - line to remove
     + line to add
    ```

Thanks, Danny. I didn't know it could do that :-) Only downside might be ensuring the kids don't type in the + and -. But I'll try it out in the next worksheet I convert and see how it works.

And thanks for your other comments - I'll factor them in.

@ghost
Copy link
Author

ghost commented Sep 21, 2018

This is the diff highlighting applied to one of the code blocks from the Egg worksheet. I think it may work for the advanced worksheets. Shame it loses the Python highlighting. But I would appreciate other opinions before I change Egg and the other worksheets that this would apply to.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants