molssi-education / cms-python-devops Goto Github PK

First line on the main page reads:

... To see the full MolSSI’s education mission statement, please see here.

I would change "see here" with "click here".

Documentation episode needs to be updated.

• How to build documentation
• autosummary for pulling out docstrings
• latex math equations
• hosting on readthedocs

"math" is a global module in python and so the name of this file should be changed in the Python Module Structure section of the tutorial.

Windows 10 includes WSL, which is "Windows Subsystem for Linux", and should be mentioned in the Python setup page as an option. Users can install the Linux version of Anaconda and follow along the rest of the tutorials.

There are no objectives in the overview section of the Git and GitHub lesson page.

It might be a good idea to tell people that they can, alternatively, cache their passwords instead of setting up ssh keys in order to reduce the number of times they input their password.

Since the overlap with our software development best practices guide seems rather high, you might find some useful material and guidelines there that you can reuse for these lesson modules.

Really excited to see this work progress!

The "Ten Things You Need to Know" is for a new website and should be removed.

It's empty and taking up space.

It might be a good idea to mention remote and branches, first time the git push is being introduced.

Include a sentence making sure users have "tree" so they can visualize the project like Python Model Structure -> Basic Structure

There are a few more objectives that aren't listed.

The key points section in the Git and Github module is blank

We can include a function which uses a random number and explain how to test that (setting random seed).

This could be in the math module with the current mean function. I propose putting this after the testing section, and perhaps emphasize writing tests before/accompanying code.

In the August 2019 bootcamp, Daniel had the students write a function which calculated pi.

In the "Making a Open-Source Python Module" document there is an incomplete sentence(?) under the Project Preliminaries section.

3. Programming Language
   • How might this influence license and