Skip to content

Commit 8def4c1

Browse files
authored
Fix typo in documentation from Github to GitHub (pyOpenSci#411)
1 parent ef75aef commit 8def4c1

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

documentation/repository-files/intro.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ at a minimum have the following files:
66

77
The files mentions above (README, Code of Conduct, license
88
file, etc) are used as a measure of package community health
9-
on many online platforms. Below, you can see an example how Github
9+
on many online platforms. Below, you can see an example how GitHub
1010
evaluates community health. This community health link is available for
1111
all GitHub repositories.
1212

@@ -21,7 +21,7 @@ GitHub community health looks for a readme file among other elements when it eva
2121

2222
[Snyk](https://snyk.io/advisor/python) is another well-known company that
2323
keeps tabs on package health. Below you can see a similar evaluation of files
24-
in the Github repo as a measure of community health.
24+
in the GitHub repo as a measure of community health.
2525

2626
```{figure} /images/moving-pandas-python-package-snyk-health.png
2727
---

index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Publish your docs
5858
```
5959
## _new_ Tutorial Series: Create a Python Package
6060

61-
The first round of our community-developed, how to create a Python package tutorial series for scientists is complete! Join our community review process or watch development of future tutorials in our [Github repo here](https://github.com/pyOpenSci/python-package-guide).
61+
The first round of our community-developed, how to create a Python package tutorial series for scientists is complete! Join our community review process or watch development of future tutorials in our [GitHub repo here](https://github.com/pyOpenSci/python-package-guide).
6262

6363

6464
:::::{grid} 1 1 2 2
@@ -187,7 +187,7 @@ Learn about best practices for:
187187
* [How to publish your docs](/documentation/hosting-tools/intro)
188188
* [Using Sphinx](/documentation/hosting-tools/intro)
189189
* [Markdown, MyST, and ReST](/documentation/hosting-tools/myst-markdown-rst-doc-syntax)
190-
* [Host your docs on Read The Docs or Github Pages](/documentation/hosting-tools/publish-documentation-online)
190+
* [Host your docs on Read The Docs or GitHub Pages](/documentation/hosting-tools/publish-documentation-online)
191191
:::
192192
::::
193193

tutorials/publish-pypi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Example: `pyosPackage_yourNameHere`.
218218

219219
#### Recommended
220220

221-
- Update the Github repository name to align with the new package name
221+
- Update the GitHub repository name to align with the new package name
222222
- Update your local project folder to match the new package name (e.g. `pyospackage_yourNameHere/src`)
223223
- Update mentions of your repository name in other files (e.g. `README.md`)
224224
:::

0 commit comments

Comments
 (0)