Improve readability of 'An example program' notebook

UCL / rsd-engineeringcourse

Course materials for Research Software Engineering course.

Other

118 stars 101 forks source link

Closed p-j-smith closed 1 year ago

p-j-smith commented 1 year ago

Fixes #225

fix hyperlinks
Add basic docstring to each function
Use more descriptive variable names.
Store intermediate results in variables for re-use and to make more explicit what we're doing
Define slices for indexing into string arrays.
Define constants for indexing into RGB channels

review-notebook-app[bot] commented 1 year ago

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

dpshelio commented 1 year ago

Thanks @p-j-smith - I've made small changes before merging it.