How to label your p5 canvas tutorial revisions

[katlich112358]

Revises #1412

Changes:

• Tutorial updated with new information and better matches the new technical writing guidelines.

[nickmcintyre]

@katlich112358 your revision looks solid! I left a few comments/suggestions.

Thanks for taking the new writing guide for a spin–excited to incorporate your feedback.

[katlich112358]

@nickmcintyre awesome, thank you! I think the new writing guide is pretty sound, my main struggle was with getting the grammar down to a 6th grade reading level (and even then I think it only made it to 9th), so maybe it could be useful to change the "grade level cap" to 8th or 9th? It more had to do with accurate code jargon naturally being above 6th grade level, I believe. 6th grade can be a good goal for grammar, but 8th is passable?

The how-to step process worked well, and I really like the idea of the "Prerequisite" section!

[nickmcintyre]

@katlich112358 good distinction between grammar and vocabulary–hadn't thought of that. I raised the "grade level cap" to 8th and will bring this up with other writers. Some things are just technical, and you struck a good balance in your how-to. Let me know how you'd like to proceed with the suggestions and we can request a merge.

[katlich112358]

@nickmcintyre Thanks! I'm still getting used to GitHub and the review process, where can I find these reviews? I don't see any pending review check on my end. Where might I find them elsewhere?

[nickmcintyre]

Minor point, but the code style guide suggests using single quotes '' and template strings `hello, ${name}`.

[katlich112358]

@nickmcintyre whoops forgot to explain that, the code widget freaked when I used single quotes and the ${} template strings? Is there something I can do within the code itself to make these styles work?

[limzykenneth]

@katlich112358 Those are considered special characters in YAML and need to be escaped. Escaping special characters in YAML is kinda messy though but there's not much way to get around it.

[katlich112358]

@limzykenneth Fixed this issue, typo on my end. Thanks!

[nickmcintyre]

@katlich112358 oops, turns out I forgot to hit the submit button.

[calebfoss]

Really excellent work on this @katlich112358! This is such a helpful resource.

[limzykenneth]

Do let us know if this is ready for merge. There are some merge conflicts, I can help resolve them if necessary. Thanks.

[katlich112358]

@limzykenneth This is ready to merge, and I would appreciate some help in fixing the merge conflicts? Thank you!

[nickmcintyre]

@katlich112358 I have one more suggestion based on this line:

If a canvas element is animated and/or interactive, represent its current state or qualities in the label. So long as you place the functions within the draw() function, they will automatically update with the shape’s new information.

I think it's actually ok to call textOutput() and gridOutput() in setup(). Here's a quick test.

[katlich112358]

@nickmcintyre Thanks for catching that! Just updated the copy.

[katlich112358]

@nickmcintyre @limzykenneth Just added the last of the proofreading revisions, this PR is ready to merge. I'm having some issues with the tests, if y'all have the time to help I'd greatly appreciate it. Thank y'all for all your help on this!