Skip to content

Commit

Permalink
Merge pull request #136 from bennybp/main
Browse files Browse the repository at this point in the history
Some small lesson fixes
  • Loading branch information
janash committed Apr 11, 2024
2 parents 06e55f8 + d2d4a87 commit e2abc4d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
10 changes: 4 additions & 6 deletions _episodes/01-package-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,18 @@ Select open_source_license:
2 - BSD-3-Clause
3 - LGPLv3
4 - Not Open Source
Choose from 1, 2, 3, 4 (1, 2, 3, 4) [1]: 2
Choose from [1/2/3/4] (1):
Select dependency_source:
1 - Prefer conda-forge with pip fallback
2 - Prefer default anaconda channel with pip fallback
3 - Dependencies from pip only (no conda)
Choose from 1, 2, 3 (1, 2, 3) [1]:
Choose from [1/2/3] (1):
Select include_ReadTheDocs:
1 - y
2 - n
Choose from 1, 2 (1, 2) [1]:
Choose from [1/2] (1):
```
````
Expand Down Expand Up @@ -355,8 +354,7 @@ Once inside the `molecool` folder (`molecool/molecool`), examine the files that
View the module (`functions.py`) in a text editor.
We see a few things about this file.
The top begins with a description of this module surrounded by three quotations (`"""`).
Right now, that is the file name, followed by our short description,
then the sentence "Handles the primary functions".
Right now, that is the sentence "Provides the primary functions".
We will change this to be more descriptive later.
CookieCutter has also created a placeholder function called `canvas`.
At the start of the `canvas` function, we have a `docstring` (more about this in [documentation]),
Expand Down
2 changes: 1 addition & 1 deletion _episodes/04-function-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def open_pdb(f_loc):

If we want to test our function, we require a pdb file.
The workshop materials downloaded during the setup include a set of pdb examples.
These are found in `molssi_beter_practices/starting_material/data/pdb/`.
These are found in `molssi_best_practices/starting_material/data/pdb/`.
We want to store these files in our `molecool` directory.
Luckily, `cookiecutter` created a folder designed specifically for that purpose.
The folder is in `molecool/data/`.
Expand Down

0 comments on commit e2abc4d

Please sign in to comment.