valentineap / ComputationalGeoscienceCourse

Materials for an introductory course in Python programming for geoscientists
7 stars 1 forks source link

Exercise 2 ready for comments #8

Closed valentineap closed 6 years ago

valentineap commented 6 years ago

https://github.com/valentineap/ComputationalGeoscienceCourse/tree/master/Practicals/Exercise%202%20-%20Variables%20and%20functions

(Note more complex variables: lists, strings etc will come in later exercise.)

charlesll commented 6 years ago

Reviewed. I added a paragraph on documenting the function. I think it is a good practice to force students to do that from the beginning. I usually find it more productive to write the documentation at the time of function writing, even if it can change with time.

Do we want to speak of kwargs, or not? I think this may be too much for the first time...

valentineap commented 6 years ago

Thanks for the docstrings addition -- that's a good idea (and something I should probably be better about.......!)

I think kwargs probably comes later.

Assigning this to @rmcgirr94 for testing. Please keep a rough note of how long it takes you to complete each practical, so we can get some idea of whether we have enough material!

rebecca-mcgirr commented 6 years ago

Made a small change in the definition of the two sumIntegers functions (in the md cells). Previously defined as: def sumIntegers(N,n0): ... for i in range(1,N+1) #changed to range(n0,N+1) ...

Otherwise, no changes, so closing this issue. I've kept record of how long each prac has taken me (this one took about 1 hour).