MyST-NB icon indicating copy to clipboard operation
MyST-NB copied to clipboard

Some confusion around the role / directive name for "glu"

Open choldgraf opened this issue 5 years ago • 2 comments

I was just showing off some of the "glue" stuff to collaborators at UC Berkeley, and a piece of feedback that I got was that it was a bit confusing to use the word glue in the Python API (and also being the name of the package), but to use the short-hand glu: for the role and directive. They said it might be easier to use glu long-term when you're comfortable with it, but that glue would be more intuitive for newcomers.

So a few thoughts:

  • We could register both glu and glue?
  • We could replace glu with glue?

What do folks think?

choldgraf avatar Mar 18 '20 22:03 choldgraf

Happy to change to glue, its just this one line change in the code (plus documentation change): https://github.com/ExecutableBookProject/MyST-NB/blob/ab4ba1d0964a7fe0a6cd516143ccc0a472b63570/myst_nb/nb_glue/domain.py#L265

We could register both glu and glue?

by the nature of domains (they specify their own, singular, name), you can't register multiple aliases

chrisjsewell avatar Mar 18 '20 22:03 chrisjsewell

I think in that case, I'd be +1 on just using "glue". I will time how long it takes me to type it 20 times :-)

glue glue glue glue glue glue glue glue glue glue glue glue glue glue glue glue glue glue glue glue lgule

damnit I messed up the last extra one, but in total it was 16s30ms. I found it pretty easy to type because of how spacing tends to be on QWERTY keyboards :-)

choldgraf avatar Mar 18 '20 22:03 choldgraf