Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

.ipynb notebooks? #8695

bgraham89 started this conversation in Ideas
Discussion options

What's your thoughts on adding .pynb files into the mix?

One difference between using .ipynb compared to .py files for algorithms, is the visual flexibility provided by markdown cells in .ipynb files. Here's an example of a markdown cell accompanying an algorithm.

markdown_render

Benefits of markdown cells include:

  • Flexible layouting with support for headers
  • The markdown cells support mathjax, so the inherent maths related to an algorithm can be written simply, and displayed nicely.

markdown_raw

There are also other benefits of .ipynb files, related to the possibility of including separate python cells:

  • It's possible to have python cells that output visualisations
  • It's possible to have python cells dedicated to parts of an algorithm.

I think all of these benefits contribute to educational scaffolding, which is in the spirit of this repository. I don't suggest replacing the .py files, as scripts themselves are executable and easy to use, but a section dedicated to .ipynb files is a way to provide more than just a script, in case anybody wants to learn more. It's worth pointing out that .ipynb files can include hyperlinks too which can be lead to further resources.

Just an idea, what are your thoughts on it?

You must be logged in to vote

Replies: 0 comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Ideas
Labels
None yet
1 participant

AltStyle によって変換されたページ (->オリジナル) /