widget-ts-cookiecutter icon indicating copy to clipboard operation
widget-ts-cookiecutter copied to clipboard

Add explanation of naming convention

Open ianhi opened this issue 5 years ago • 0 comments
trafficstars

My understanding of the the widget naming convention is that the names are like so: Python: ipy<something> typescript: jupyter-<something>

With the idea being that the typescript part will be kernel-langauge agnostic and so shouldn't have an ipy in the name. i.e. if someone wanted make a cpp version of the widget they would only have to write cpp<something> they could then hook up to jupyter-<something> without ever having to write any typescript.

Conditional on the above being a correct assessment maybe this should be added to the top level readme of this repo?

Or in a more extreme move the cookiecutter could be changed to hint at this convention.

ianhi avatar Jul 11 '20 15:07 ianhi