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

Revisions to Guide as part of Fiverr gig #1419

Open
wants to merge 25 commits into
base: master
Choose a base branch
from

Conversation

Gravity-Well
Copy link

First one 3rd of Unit 1

@google-cla
Copy link

google-cla bot commented Aug 17, 2020

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

Copy link
Collaborator

@cdsmith cdsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

web/help/GuideUnit1.md Outdated Show resolved Hide resolved
something. Usually in math, variables are just one letter long and store
numbers. In CodeWorld, though, variables can store many different types of
things: numbers, pictures, colors, text, and even whole programs. Because
you will use so many of them, you can name variables with whole words. There are some rules for naming variables. Most importantly, they must start with a *lower-case* letter and cannot contain spaces.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[minor nit] Can we keep line breaks at around the same column in the source? Just makes it easier to read.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely. I did just let it auto-wrap.

web/help/GuideUnit1.md Outdated Show resolved Hide resolved
web/help/GuideUnit1.md Outdated Show resolved Hide resolved
web/help/GuideUnit1.md Outdated Show resolved Hide resolved
web/help/rlt-notes-unit1.md Outdated Show resolved Hide resolved
web/help/rlt-notes-unit1.md Outdated Show resolved Hide resolved
web/help/rlt-notes-unit1.md Outdated Show resolved Hide resolved
web/help/rlt-notes-unit1.md Outdated Show resolved Hide resolved
@@ -0,0 +1 @@
test file
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to delete this test file?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did mean to. It was just to make sure comited and pushed okay.

web/help/GuideUnit1.md Outdated Show resolved Hide resolved
@cdsmith cdsmith changed the title Fiverr Revisions to Guide as part of Fiverr gig Aug 23, 2020
Did you mean to reference a butterfly but not draw one?
I understand your point. Just wondering if the student might be
expecting a butterfly? Probably not if they understand polyline
at this point but just making sure.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do see the possibility of confusion. If you can explain the same idea and avoid that, go for it!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a very simple butterfly. It's on the remote repo, but won't show up when using the preview link you sent. I am I doing something wrong?

https://code.world/doc.html?path=https://raw.githubusercontent.com/Gravity-Well/codeworld/fiverr/web/help/GuideUnit1.md

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, this is right. Clickable code is the one thing that won't work in the preview URL. That's because you are just looking at the guide, without the main CodeWorld window behind it. Once I merge the pull request and students read it using the CodeWorld site, it will work.

If you really want them to see it inside the guide itself, then you can do that with an iframe. You can search for iframe in the file, and copy one of those lines. Replace the URL with the one you get by choosing "Share Without Code" from the Share dialog in CodeWorld. That will actually run the code inside the Guide itself.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As for this particular usage, I think this loses the point of the example. The idea was to start with just the coordinate plane, then add points one by one. If you just show them the completed program, I don't think it communicates that very well.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe if I reduced it to part of the butterfly. For example, part of the left wing. I'm just trying to make a bit more than an empty polyline.
After showing part of the left wing, explain to them how they could remove the coordinate plane, view it, put it back in and add more. Thoughts

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect the right thing to do here is to include multiple steps, and show how they can add to the program one vertex at a time. It should probably be in a callout box if it gets that long, just to delineate it well from the rest of the text.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to contribute in a meaningful way. I'd enjoy creating those steps if you think it would enhance the point. I think it would. But I can skip it and we can move on if you do not. Let's consider a video chat soon to discuss some of your ideas. The only real restrictions on my time are video calls I have on T,TH and F from 10:30-2:00 EST. Other than that, tasks can be shuffled.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, as I mentioned, I do think more detail here would be an improvement. Just put it in a callout box so it doesn't interrupt the flow too much. Will contact you elsewhere about setting up a video call.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do plan to do the incremental butterfly. Just did not include it in this push.


~~~~~ . clickable
program = drawingOf(halfCircle & coordinatePlane)
halfCircle=arc(-90,90,5)
Copy link
Collaborator

@cdsmith cdsmith Aug 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nit: I'd like to encourage students to use spaces around the equal sign, so let's at least model that for them. Same for the other two examples you added here.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha

halfTire=thickArc(-90,90,5,4)
~~~~~

Notice the thickness is split between both sides of the arc.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure it will be clear what you mean by this, and you may need to be more explicit and refer to the coordinate plane: for example, by pointing out that when the curve intersects the x axis, it is centered around an x value of 5, but it extends all the way from 3 through 7. It could be useful to copy the image with the coordinate plane, and show it here.

(Copying an image is a little tricky. Basically, you want to run the program, right-click on it, then wait for the on-screen controls to go away before choosing "Save image as..." in your browser. Then you can add the file to your git branch in the web/help directory, and then refer to it from Markdown. Alternatively, you can use the iframe pattern to just run the program inline. Either will work, though I normally try to save the image unless I am going for some kind of animation or interactive demo.)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeh. I was having trouble with the wording but though it was important to point out how the thickness worked. I'll add more of a description and an 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

Successfully merging this pull request may close these issues.

2 participants