Skip to content

Commit 831a285

Browse files
committed
Fix: spellcheck and final cleanup
1 parent d9ed95d commit 831a285

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

tutorials/1-installable-code.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ will have the bare minimum elements needed to be installable into a Python envir
1313

1414
:::{todo}
1515
1. Is it clear where to add commands? bash vs. Python console
16-
Bash vs zsh is different
16+
Bash vs. Zsh is different
1717
2. Does this lesson run as expected on windows and mac?
18-
3. ADD: note about what makes something "package worthy", with a common misconception being that a package should be production-ready code that's valuable to a broad audience. this may not be a pervasive misconception in python, but a quick break-out with an explanation of what a package can consist of would be helpful.
18+
3. ADD: note about what makes something "package worthy", with a common misconception being that a package should be production-ready code that's valuable to a broad audience. this may not be a pervasive misconception in Python, but a quick break-out with an explanation of what a package can consist of would be helpful.
1919
:::
2020

2121
:::{figure-md} code-to-python-package
@@ -60,7 +60,7 @@ In the upcoming lessons you will learn how to:
6060

6161
:::{figure-md} packages-environment
6262

63-
<img src="../images/tutorials/environment-package-install.png" alt="This diagram has two smaller boxes with arrows pointing to the right to a python environment. The small boxes read your-package and pip install package. The environment box on the right reads - your python environment. It them lists your-package along with a few other core packages such as matplotlib, numpy, pandas, xarray and geopandas." width="700px">
63+
<img src="../images/tutorials/environment-package-install.png" alt="This diagram has two smaller boxes with arrows pointing to the right to a Python environment. The small boxes read your-package and pip install package. The environment box on the right reads - your Python environment. It them lists your-package along with a few other core packages such as Matplotlib, NumPy, Pandas, Xarray and GeoPandas." width="700px">
6464

6565
Making your code installable is the first step towards
6666
creating a publishable Python package. Once your code is
@@ -162,7 +162,7 @@ can always [fork and clone and customize the pyOpenSci example package.](https:/
162162
## Step 1: Set Up the Package Directory Structure
163163

164164
Below you create the basic directory structure required
165-
for your Python package. Note that there are instructions for creating the files and directories using shell. However you can also create files and directories in your preferred file directory tool (e.g. Finder on MAC or File Explorer on Windows or even a tool such as VSCode or Spyder) if you wish.
165+
for your Python package. Note that there are instructions for creating the files and directories using shell. However you can also create files and directories in your preferred file directory tool (e.g. Finder on MAC or File Explorer on Windows or even a tool such as VS Code or Spyder) if you wish.
166166

167167
### Create your package's project directory structure
168168
* Create a new project directory for your package. Choose a name for your package, preferably in lowercase and without spaces. For this tutorial we'll use `pyospackage`.

0 commit comments

Comments
 (0)