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.

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

Jump to bottom

Update 010exemplar notes #225

Closed
p-j-smith opened this issue Feb 28, 2023 · 0 comments · Fixed by #227
Closed

Update 010exemplar notes #225

p-j-smith opened this issue Feb 28, 2023 · 0 comments · Fixed by #227

Comments

@p-j-smith
Copy link
Contributor

There are also a few improvements / fixes needed for An example program:

  • the link to the Software Carpentry course is broken

  • functions are missing docstrings

  • some variable and function names could be more descriptive

  • some of the code is quite opaque. Intermediate results could be stored in variables to make it easier to follow what the code is doing

  • slice could be used to define constants for indexing arrays / strings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve readability of 'An example program' notebook UCL/rsd-engineeringcourse
1 participant
@p-j-smith