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

Tutorial examples #35

Closed
3 tasks
ots22 opened this issue Sep 22, 2021 · 2 comments · Fixed by #123
Closed
3 tasks

Tutorial examples #35

ots22 opened this issue Sep 22, 2021 · 2 comments · Fixed by #123

Comments

@ots22
Copy link
Member

ots22 commented Sep 22, 2021

  • rationalize current tutorials: split first part out
  • add short set-mode tutorial
  • add smaller data set and use this with the examples that currently use the large dataset: can add a link to the large dataset, and perhaps commented-out notebook cell that uses it
@ots22
Copy link
Member Author

ots22 commented Oct 25, 2021

Roy's comments:

Solution
I think it would be better to insert solution images at the relevant points of the notebook (as is already done for igr_result = igr(df[igr_columns], gaps), rather than adding them in interactive form at the end, which forces users to scroll back and forth, and interact with yet more things rather than just compare what they have with the solution.

Put description before code, rather than splitting it before/afterwards,e.g., as currently the case for PlotSession()

Put the Green boxes above the relevant code, not sometimes above and at other times below.

Add comments to clearly distinguish between cells that users must run vs. cells that provide additional background info, e.g., help(igr).

@layik
Copy link
Collaborator

layik commented Feb 2, 2023

I wonder if the two Example notebooks by Roy addresses this ticket @ots22? Or should we close it in favour of #58? Certainly "short set-mode tutorial" is in there.

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

Successfully merging a pull request may close this issue.

2 participants