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

Increase consistency across episodes #115

Open
jhlegarreta opened this issue Apr 1, 2021 · 1 comment
Open

Increase consistency across episodes #115

jhlegarreta opened this issue Apr 1, 2021 · 1 comment
Labels
help wanted Looking for Contributors type:formatting Formatting needs to be fixed

Comments

@jhlegarreta
Copy link
Contributor

jhlegarreta commented Apr 1, 2021

Episodes should be made consistent:

  • Some Jupyter notebooks still contain the output cells (e.g introduction or DTI. This might be interesting for the solutions, to have a reference of what the output should look like (although they should be in the markdown files as well) but I'd say that it is not for the raw notebooks that will be used for teaching.
  • We should maybe decide if Jupyter notebooks will contain the static images. I would maybe remove them. This saves maintenance work (until an automatic method that works flawlessly is found Automatically generate the Markdown episodes from the Jupyter Notebooks? #85) and reduces the risk of discrepancies between the episode markdown and notebooks.
  • Similarly, some episodes (e.g. DTI) do not contain the instructions to save the figures, whereas others do (e.g. CSD, tracking). Although this is strictly not relevant for learners, it is useful for developers; otherwise, they need to manually add the commands every time a change to the figures is needed.
  • We should define as variables initialized at a single place and value values that are used repeatedly (e.g. the subject id, the FA threshold, etc.). Eases maintenance and reduces the possibility of incurring into bugs.
@jhlegarreta jhlegarreta added the type:formatting Formatting needs to be fixed label Apr 1, 2021
@kaitj
Copy link
Collaborator

kaitj commented Apr 2, 2021

Some Jupyter notebooks still contain the output cells (e.g introduction or DTI. This might be interesting for the solutions, to have a reference of what the output should look like (although they should be in the markdown files as well) but I'd say that it is not for the raw notebooks that will be used for teaching.

I think the intro notebook is just a matter of not having been updated yet. The DTI I may have missed. Will clear this one when I add the exercises for #30 or #105.

We should maybe decide if Jupyter notebooks will contain the static images. I would maybe remove them. This saves maintenance work (until an automatic method that works flawlessly is found #85) and reduces the risk of discrepancies between the episode markdown and notebooks.

This might have just been a result of trying to match notebooks with markdown files. Definitely a discussion to be had, but I am ok with removing figures that are generated out of the notebook.

@jhlegarreta jhlegarreta added the help wanted Looking for Contributors label Nov 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Looking for Contributors type:formatting Formatting needs to be fixed
Projects
None yet
Development

No branches or pull requests

2 participants