Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Script template triage #409

@hinerm

Description

@hinerm

We have a lot of templates in the Script Editor that are in different states of functionality and desirability.

Current triage doc

Assessment criteria

  • Does the template work?
  • Is this a tutorial, or just a code snippet?
  • Is the concept useful? If so, why? (what is the utility of showing this in the script editor?)
  • If so, is the intended audience? (developer, user - at what skill level?)
  • Should this be a Teacher framework topic, or is it appropriate for the Script Editor?
  • What should the name of this tutorial actually be?

For example, the Invert_image.rb is so trivial it should not be a script template, while Colocalisation is a core concept we should teach in the teacher framework. A name like "Wiki Jython Tutorial 1" is not helpful.

Other considerations

  • How do we interactively explain the @parameter and @OUTPUT concepts? A template is OK, but perhaps a "command palette" for inserting and exploring things that can be auto-populated would be more appropriate? More ideas welcome.
  • How should we actually access these templates? Right now, the "By language" menu is the cleanest experience for browsing them (to me, as a developer) but the other menus can feel disjointed, messy, repetitive and a bit overwhelming. I hope that by doing this triage we can find some more natural groupings. But perhaps the menu is not an ideal way to browse. For example, Google Colab has a File > Open > Examples browser which is distinguished from a Snippets menu for small, reusable code pieces.
  • All templates should be documented to clearly explain why we are doing this as a script. What did we gain? This can also be approached from the Teacher framework, but these scripts should stand on their own.
    • reproducibility
    • input harvesting
    • cooler function usage
    • python (or other) library usage

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

Backlog

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions