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.

Sign up for GitHub

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

Scripts should say what they do #15

Open

mauro3 opened this issue Oct 30, 2023 · 0 comments

Collaborator

mauro3 commented Oct 30, 2023

It would be helpful to add comment lines to each script's top to state:

what part of each lecture they belong to
what equation they solve
what method they use

Bonus points for actually stating the equation.

I realize that some of that is encoded in the file name, but I cannot decode that.

For instance for https:/eth-vaw-glaciology/course-101-0250-00/blob/main/scripts/l2_diffusion_1D.jl:

# Lecture 2.2a Parabolic PDEs - solve diffusion equation with explicit forward Euler step
#
# ∂C/∂t = D ∂²C/∂x²

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment