Revisions to Guide as part of Fiverr gig by Gravity-Well · Pull Request #1419 · google/codeworld

Gravity-Well · 2020-08-17T09:12:12Z

First one 3rd of Unit 1

google-cla · 2020-08-17T09:12:33Z

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

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

cdsmith

Left some comments here.

The link to check how this renders is https://code.world/doc.html?path=https://raw.githubusercontent.com/Gravity-Well/codeworld/fiverr/web/help/GuideUnit1.md

web/help/GuideUnit1.md

cdsmith · 2020-08-17T11:50:20Z

web/help/GuideUnit1.md

+  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.


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

Definitely. I did just let it auto-wrap.

web/help/GuideUnit1.md

web/help/rlt-notes-unit1.md

cdsmith · 2020-08-17T12:26:11Z

web/help/ztest.md

@@ -0,0 +1 @@
+test file


Did you mean to delete this test file?

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

web/help/GuideUnit1.md

cdsmith · 2020-08-24T15:01:22Z

web/help/rlt-notes-unit1.md

+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.


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

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

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.

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.

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

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.

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.

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.

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

cdsmith · 2020-08-30T13:25:58Z

web/help/GuideUnit1.md

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


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.

cdsmith · 2020-08-30T13:32:34Z

web/help/GuideUnit1.md

+halfTire=thickArc(-90,90,5,4)
+~~~~~
+
+Notice the thickness is split between both sides of the arc.


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.)

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.

Gravity-Well added 4 commits August 10, 2020 10:51

fc

3f04fb8

sc

b60a0fe

notes1

eec3295

One third. First pass editing

466e082

cdsmith reviewed Aug 17, 2020

View reviewed changes

Edits after first pull request

9c401c5

cdsmith reviewed Aug 21, 2020

View reviewed changes

web/help/GuideUnit1.md Outdated Show resolved Hide resolved

Gravity-Well added 3 commits August 21, 2020 08:16

Removed references to variable stores and assigns

a17a7a5

Removed premature reference to operator

03f4d68

Cleared prior notes added one

deb5c38

cdsmith changed the title ~~Fiverr~~ Revisions to Guide as part of Fiverr gig Aug 23, 2020

cdsmith reviewed Aug 24, 2020

View reviewed changes

Gravity-Well added 2 commits August 26, 2020 10:10

Add butterfly

f051f94

Add arc and sector example

7b5e2d9

cdsmith reviewed Aug 30, 2020

View reviewed changes

Gravity-Well added 13 commits August 31, 2020 16:35

Start butterfly callout. No image yet

0b4ec70

Fix butterfly callout. No image yet

5c93e3e

Improving butterfly

6abd151

Improving butterfly 2

1a85671

Change to understanding mistakes

4890ec9

Change to understanding mistakes

3e11b42

Correct spelling in Mistakes section

a77c5ad

Added two parse error examples to 3.1

00b1273

Added two parse error examples to 3.3

0f35720

Added exercise to section 1.2

1353af4

Added exercise to section 1.2

a739e6a

Added exercise 1.2 image

03af14b

Added exercise to section 1.4

9e6b278

Gravity-Well added 2 commits October 3, 2020 11:33

Added 2nd exercise to section 1.4

a10b670

Added 2nd exercise to section 1.4

e9506f9

Conversation

Gravity-Well commented Aug 17, 2020

Uh oh!

google-cla bot commented Aug 17, 2020

What to do if you already signed the CLA

Individual signers

Corporate signers

Uh oh!

cdsmith left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cdsmith Aug 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cdsmith Aug 30, 2020 •

edited

Loading