Skip to content

Commit

Permalink
Grammar tweaks to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
blowekamp committed Jul 21, 2023
1 parent 8c5ccb5 commit 1e3cbf1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ Linting

The linting processes are configured and run with `pre-commit <https://pre-commit.com>`_. 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 <https://pre-commit.com/#quick-start>`_.

The linting process uses both `Black <https://black.readthedocs.io/en/stable/>`_ and
`flake8 <https://flake8.pycqa.org/en/latest/>`_ to ensure uncompromising code formatting and some programmatic problems.
The Black must be used to auto format new code before committing:
`flake8 <https://flake8.pycqa.org/en/latest/>`_ 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
Expand Down
2 changes: 1 addition & 1 deletion docs/example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1e3cbf1

Please sign in to comment.