diff --git a/docs/devcontainer.md b/docs/devcontainer.md index 7b7bfd2f..8dcf216f 100644 --- a/docs/devcontainer.md +++ b/docs/devcontainer.md @@ -1,7 +1,7 @@ # GitHub Codespace The project's Codespace configuration is located in ".devcontainer". It includes the "Dockerfile" for the development container. -The project can be opened directly in a Codespace. +The project can be opened directly in a Codespace. ## Running Unit Tests diff --git a/docs/pre-commit-config.md b/docs/pre-commit-config.md index f05fc3cb..b7761829 100644 --- a/docs/pre-commit-config.md +++ b/docs/pre-commit-config.md @@ -1,6 +1,6 @@ # pre-commit-config.yaml Pre-commit is a Python package which can be used to create 'git' hooks which scan can prior to checkins. -The included configuration focuses on python actions which will help to prevent users from commiting code which will fail during builds. -In general, only formatting actions are automatiicaly performed. These include auto-formatting with 'black', or sorting dependacies with 'isort'. +The included configuration focuses on python actions which will help to prevent users from committing code which will fail during builds. +In general, only formatting actions are automatically performed. These include auto-formatting with 'black', or sorting dependencies with 'isort'. Linting actions are left to the discretion of the user. diff --git a/src/README.md b/src/README.md index faa68b25..f51b561e 100644 --- a/src/README.md +++ b/src/README.md @@ -1 +1 @@ -This directoy stores each Python Package. +This directory stores each Python Package.