Skip to content

Commit 2374225

Browse files
lwasserbillbrod
andcommitted
Apply suggestions from code review
Co-authored-by: William F. Broderick <[email protected]>
1 parent 88898db commit 2374225

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

tutorials/intro.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ The core elements of Python package include:
9292
- **License:** An open source license …. - link to choose a license…
9393
- **Infrastructure** that automates updates, publication workflows and runs test suites
9494

95-
If you intend for others to use and contribute to your code, consider who will maintain it over time. You will want a **contributing / development** guide to help new potential contributors get started with contributing to your package. And a **code of conduct** to ensure community interactions remain healthy both for you and your contributors / maintainer team
95+
If you intend for others to use and contribute to your code, consider who will maintain it over time. You will want a **contributing / development** guide to help new potential contributors get started with contributing to your package, as well as a **code of conduct** to ensure community interactions remain healthy both for you and your contributors / maintainer team
9696

9797
:::{admonition} What pyOpenSci looks for in a package
9898
:class: tip
@@ -120,7 +120,7 @@ By publishing your package on GitHub or GitLab, you are now making your code pub
120120
:::{admonition} GitHub & GitLab vs. Git
121121
:class: tip
122122

123-
GitHub and GitLab are online (cloud) platforms that run git (version control
123+
GitHub and GitLab are online (cloud) platforms that run `git` (version control
124124
software) on the backend. Running git locally on your computer allows you to
125125
upload (`git push`) and download (`git pull`) files to GitHub and GitLab.
126126
:::
@@ -196,7 +196,7 @@ data, and analyses used in a study.
196196

197197
A Python package however is a collection of modules that are focused on a
198198
specific set of tasks that can be applied across numerous research projects.
199-
As such a Python package is more generalizable than a research Compendium
199+
As such a Python package is more generalizable than a Research Compendium
200200
which supports a specific project.
201201

202202
:::
@@ -217,7 +217,7 @@ You don't have to publish to PyPI in order to make your code installable.
217217
WIth the correct file structure and project metadata you can make your code
218218
installable locally on your computer and use it for projects that you are working
219219
on without having to ever publish to PyPI. Publishing to PyPI is useful when you
220-
want to make your code public facing and share it with others.
220+
want to make your code public-facing and share it with others.
221221
:::
222222

223223
### Publishing a package
@@ -228,7 +228,7 @@ pure python package, then publishing to both PyPI and conda-forge only takes jus
228228

229229
In these tutorials, you will learn [how to publish to PyPI using twine.](6-publish-pypi.md)
230230

231-
Then you can create a conda-forge recipe using the grayskull tool. This recipe can then be submitted to conda-forge. [You will learn more about the conda-forge publication process here.](7-publish-conda-forge.md)
231+
Then you can create a conda-forge recipe using the [grayskull](https://github.com/conda/grayskull) tool. This recipe can then be submitted to conda-forge. [You will learn more about the conda-forge publication process here.](7-publish-conda-forge.md)
232232

233233

234234
:::{figure-md} build-workflow-tutorial

0 commit comments

Comments
 (0)