From 1e3cbf11d83b4e11beaf2462444cc7796af2778b Mon Sep 17 00:00:00 2001 From: Bradley Lowekamp Date: Fri, 21 Jul 2023 13:00:44 -0400 Subject: [PATCH] Grammar tweaks to docs --- docs/development.rst | 6 +++--- docs/example.rst | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/development.rst b/docs/development.rst index df7a3b8..4e83827 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -25,14 +25,14 @@ Linting The linting processes are configured and run with `pre-commit `_. Using pre-commit provides a single file ( ".pre-commit-config.yaml" ) configuration for both execution of CI and local git pre-commit hooks. The -"pre-commit" package does not need to be installed in the projects venv. One initialized for the project, pre-commit +"pre-commit" package does not need to be installed in the projects venv. Once initialized for the project, pre-commit will manage the versions of the tools in a separate environment, that is automatically managed. The following is the `quick start guide `_. The linting process uses both `Black `_ and -`flake8 `_ to ensure uncompromising code formatting and some programmatic problems. -The Black must be used to auto format new code before committing: +`flake8 `_ to ensure uncompromising code formatting and identify programmatic +problems. The black code formatting tool must be used to auto format new code before committing: .. code:: bash diff --git a/docs/example.rst b/docs/example.rst index 56533d9..aff2189 100644 --- a/docs/example.rst +++ b/docs/example.rst @@ -19,7 +19,7 @@ To classify a single image: print("{} is an outlier".format(path_to_file)) -Multiple images can efficiently be processed by using Python `map` function, which +Multiple images can efficiently be processed by using Python's `map` function, which .. code-block:: python