Skip to content

Commit 16ae1cd

Browse files
lwasserbillbrod
andcommitted
Fix: edit from @billbrod
Co-authored-by: William F. Broderick <[email protected]> Fix: edit from @billbrod Co-authored-by: William F. Broderick <[email protected]> Fix: edit from @billbrod Co-authored-by: William F. Broderick <[email protected]> Fix: edit from @billbrod Co-authored-by: William F. Broderick <[email protected]>
1 parent 8cac479 commit 16ae1cd

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

tutorials/intro.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ well.
7676

7777
A package is installable, which means that you can add the
7878
functionality within the package's code to any Python environment and
79-
import that functionality like you would import core Python packages such
79+
import that functionality like you would import core scientific Python packages such
8080
as NumPy or Matplotlib.
8181

8282
```python
@@ -93,7 +93,7 @@ You might create a Python package because you want to:
9393

9494
- **Use your code across different projects:** At its most basic level, creating a package allows you to install your code into a Python environment. This allows you to then import functions and classes into any workflows both locally and in the cloud.
9595
- **Share your code:** If you publish a package on a public repository such as PyPI or conda, your package can be installed on any machine using pip or conda with a single command.
96-
- **Build community around your code:** Packages make it easier for multiple people to work on the same project (particularly when published on GitHub). A version platform such as git (the version control system used by GitHub), further makes it easier to track changes to the codebase over time. Tools such as issues and pull requests make it easier for outside users to contribute bug fixes and to establish review processes for accepting changes to the code base.
96+
- **Build community around your code:** Packages make it easier for multiple people to work on the same project (particularly when published on GitHub). A version control system such as git (the system used by GitHub), further makes it easier to track changes to the codebase over time. Tools such as issues and pull requests make it easier for outside users to contribute bug fixes and to establish review processes for accepting changes to the code base.
9797
- **Organize your code:** Packages can be used to organize large code projects, dividing them into smaller, more manageable components. This structure can help with both maintaining the codebase and with making it easier to understand.
9898

9999
### What to consider before you create a package
@@ -127,7 +127,7 @@ The core elements of Python package include:
127127
- Contributor Documentation in the form of a **CONTRIBUTING.md** file is useful to help people to contribute to your package.
128128
- Development Documentation helps both maintainers and contributors understand how to maintain a package's infrastructure.
129129
- **Tests:** that make sure your code works as it should and makes it easier for you and others to contribute to, modify and update the code in the future
130-
- **License:** An open source license, or license that is [OSI approved](https://opensource.org/licenses/) refers to an license that allows others to use your package. It also provides legal direction regarding how elements of the package can and can't be reused.
130+
- **License:** An open source license, or license that is [OSI approved](https://opensource.org/licenses/), refers to an license that allows others to use your package. It also provides legal direction regarding how elements of the package can and can't be reused.
131131
- **Infrastructure** that automates updates, publication workflows and runs test suites. Infrastructure includes a suite of things such as platforms like GitHub and GitLab, tools to run tests and tools locally such as nox and tox and continuous integration that automates package maintenance steps.
132132

133133
:::{admonition} What pyOpenSci looks for in a package
@@ -174,7 +174,7 @@ GitHub and GitLab also both offer community features such as issues that allow:
174174

175175
### Continuous integration and continuous deployment
176176

177-
GitHub and GitLab also provide continuous integration and continuous deployment (CI/CD). Continuous integration (CI) refers to a platform that automatically runs a specific job when a certain event occurs.
177+
GitHub and GitLab also provide continuous integration and continuous deployment (CI/CD). Continuous integration (CI) refers to a platform that automatically runs a specific job when a certain event occurs, whereas continuous deployment (CD) is a form of CI that runs before publication.
178178

179179
**An example of Continuous integration:**
180180
* When someone submits a change to your code, your tests will run across different operating systems and the code will be checked for format issues.

0 commit comments

Comments
 (0)