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

Document the notebooks #17

Open
NobleKennamer opened this issue Dec 7, 2015 · 0 comments
Open

Document the notebooks #17

NobleKennamer opened this issue Dec 7, 2015 · 0 comments

Comments

@NobleKennamer
Copy link
Owner

@arielkruger1989 @abhisaarsharma @dcockerham

If people could document the main notebooks RR_Lyrae.ipynb and redshift.ipynb so that the graders can easily follow everything that is happening that would be great.

Instead of adding comments into the executable cells create markdown cells directly above them to add the documentation. That looks a lot nicer. Plus the markdown cells support HTML so we can really make them look nice.

a good tutorial for adding this markdown can be found in the link below(it is actually really easy)

http://jupyter.cs.brynmawr.edu/hub/dblank/public/Jupyter%20Notebook%20Users%20Manual.ipynb

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

No branches or pull requests

1 participant