search

numberscope / frontscope

Numberscope's front end and user interface: responsible for specifying sequences and defining and displaying visualizers
MIT License
7 stars 15 forks source link

Update documentation to reflect changes to visualizer class, and concomitant changes to Turtle and p5Template #399

Closed katestange closed 4 months ago

katestange commented 4 months ago

By submitting this PR, I am indicating to the Numberscope maintainers that I have read and understood the contributing guidelines and that this PR follows those guidelines to the best of my knowledge. I have also read the pull request checklist and followed the instructions therein.

In view of recent changes to the p5 visualizer class (parameter data structure and validation, handling aspect ratios and presketch function), this PR does the following:

  1. updates the documentation making-a-visualizer.md to reflect these changes
  2. updates the P5Template visualizer in the workbench to agree with said documentation and reflect these changes
  3. cleans up the Turtle visualizer: make use of parameter-specific validation, reorder/prioritize the parameters according to importance, add a picture to documentation, change default values for aesthetics.

This PR started out as looking over the Turtle visualizer, not to add functionality, but just to clean up and adapt to the recent visualizer class changes, but then became primarily a documentation PR about these new changes. So it is a slightly hybrid PR, forgive me.

katestange commented 4 months ago

I believe I have addressed @gwhitney 's review comments.

gwhitney commented 4 months ago

Looks good and the two modified visualizers run fine. Merging.