From 2c0382411cf2841306ca8d94eea915397cf03857 Mon Sep 17 00:00:00 2001 From: Benjamin Pritchard Date: Thu, 11 Apr 2024 09:47:14 -0400 Subject: [PATCH 1/2] Update output of cookie cutter --- _episodes/01-package-setup.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/_episodes/01-package-setup.md b/_episodes/01-package-setup.md index c75fccd..987aced 100644 --- a/_episodes/01-package-setup.md +++ b/_episodes/01-package-setup.md @@ -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): ``` ```` @@ -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]), From d2d4a878cc3a40ca18c9aebcd1052d45a751ed8c Mon Sep 17 00:00:00 2001 From: Benjamin Pritchard Date: Thu, 11 Apr 2024 10:07:20 -0400 Subject: [PATCH 2/2] Fix typo --- _episodes/04-function-style.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_episodes/04-function-style.md b/_episodes/04-function-style.md index 3702a28..f5c0eb9 100644 --- a/_episodes/04-function-style.md +++ b/_episodes/04-function-style.md @@ -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/`.