Skip to content

Commit

Permalink
Fix: more edits from the review
Browse files Browse the repository at this point in the history
  • Loading branch information
lwasser committed Dec 22, 2023
1 parent e14ef71 commit 0d0e331
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
3 changes: 0 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ Learn about our open peer review process
:::
::::

<!-- I think this is the end of the header - below begins the next grid-->

::::{grid} 1 1 2 2
:class-container: text-center
Expand Down Expand Up @@ -162,8 +161,6 @@ Learn about our open peer review process
:::
::::

<!-- I think this is the end of the header - below begins the next grid-->

::::{grid} 1 1 2 2
:class-container: text-center
:gutter: 3
Expand Down
8 changes: 4 additions & 4 deletions tutorials/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ well.

<img src="../images/tutorials/package-components.png" alt="Diagram showing .. more here if this stays." width="500px">

The elements of a Python package include code, documentation, tests a OSI-approved license and a specific directory structure. Maintainers are at the core making sure everything works and is up to date while fixing bugs and addressing user concerns.
The elements of a Python package include code, documentation, tests, an OSI-approved license and a specific directory structure. Maintainers are at the core making sure everything works and is up to date while fixing bugs and addressing user concerns.
:::

The core elements of Python package include:
Expand Down Expand Up @@ -114,11 +114,11 @@ A package in any language is more than just code. If your package is public faci
### Version control and storing your package on GitHub or GitLab

Most Python packages live in an online version control platform such as GitHub
or GitLab. GitHub and GitLab are both online platforms that
run [git](https://git-scm.com/) for version control. Have your software
or GitLab. GitHub and GitLab are both
run [git](https://git-scm.com/) for version control. Having your software
under version control is important because it allows you to both track changes over time while also going back in history and undoing changes in the case that a change to the code base unexpectedly breaks something.

By publishing your package on GitHub or GitLab, you are now making your code public facing. this means that others can both see your code and also make contributions using a pull request - review workflow.
By publishing your package on GitHub or GitLab, you are making your code public facing. This means that others can both see your code and also make contributions using a pull request (merge request in GitLab) - code review workflow.

:::{admonition} GitHub & GitLab vs. Git
:class: tip
Expand Down

0 comments on commit 0d0e331

Please sign in to comment.