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

Planned updates to Module 6 #130

Open
6 tasks
andrewphilipsmith opened this issue Oct 19, 2022 · 1 comment
Open
6 tasks

Planned updates to Module 6 #130

andrewphilipsmith opened this issue Oct 19, 2022 · 1 comment
Assignees

Comments

@andrewphilipsmith
Copy link
Contributor

andrewphilipsmith commented Oct 19, 2022

Discussion with @nbarlowATI and @andrewphilipsmith:

  • Rename 6.2 to "Managing Dependencies and Environments" (ie include the environments in the heading to emphasise their importance)
  • add something 6.4 dividing up code into sensible manageable chunks in .py files. Also, you can use packaging to hide the implementation details from consumers of your code.
  • 6.6 needs a "further reading" section. Emphasise that this is a huge topic that must be adapted to individual, institutional and project settings.
  • 6.8 Issues - reproduce/actual behaviour/expected behaviour (see https://www.joelonsoftware.com/2000/11/08/painless-bug-tracking). Everything else is optional - probably good practice and can be adapted to your project/team/institution.
  • 6.4 packaging - mention CI/CD as a way to do packaging.

Potential for the future:

  • Separate or highlight the sections which are objective statements about python, vs opinions/subjective/best practise guides about software development.
@andrewphilipsmith
Copy link
Contributor Author

Also, to review (after having worked through the exercise ourselves):

Could the exercise be moved to earlier? eg

  • talk 6.0-6.5,
  • then do the exercise
  • come back and have a quick debrief on the exercise
  • talk 6.6-6.8

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

2 participants