Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add explanation of naming convention #76

Open
ianhi opened this issue Jul 11, 2020 · 0 comments
Open

Add explanation of naming convention #76

ianhi opened this issue Jul 11, 2020 · 0 comments

Comments

@ianhi
Copy link
Contributor

ianhi commented Jul 11, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant