-
Notifications
You must be signed in to change notification settings - Fork 75
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
Suggestions for Executable Markdown Files Documentation #1846
Comments
Part of my confusion was that I somehow jumped to Executable Markdown Files first instead of Executable Documents. The latter is somewhat clearer. Maybe this is simply point to to the latter, and/or adding a Prerequisites section to the former with something like:
Is a "Goals and prerequisites" section appropriate for Executable Markdown Files, or are those reserved for quickstart files? |
I put up a few improvements in #1852. I think there are still more needed and would love help from you! |
While trying to read through and follow the Executable Markdown Files docs, I ran into some issues that could be clarified:
jupyter
in addition tomystmd
. This is almost obvious, but not completely transparent from the quickstart repo, since it installsjupyterlab_myst
which in turn pulls in jupyter.---
pairs.LANGUAGE defines the language to be used in executing the code.
This implies that you can select different kernels in the code cells by specifyingLANGUAGE
, which (I think) is not currently the case (see also https://github.com/orgs/executablebooks/discussions/1137). Other similar language exists in the page: as far as I can tell, one cannot use multiple kernels, andLANGUAGE
is just used for code formatting - is this still true?For someone not intimately familiar with: This is included belowipykernel
, the mean of the kernelname
anddisplay_name
is quite mysterious. I suggest including either a margin-note or admonition explaining how to find out what names are valid...jupyter kernelspec list
I suggest just including this in the table.I will include more as I work though, then submit a PR.
The text was updated successfully, but these errors were encountered: