Skip to content

Commit

Permalink
Minor fixes on documentation pages (#1719)
Browse files Browse the repository at this point in the history
* Fix typo on env var name GITHUB_WORKFLOW

* Fix minor typo on usage.rst

* Update pipx project's URL
  • Loading branch information
pabluk committed Sep 7, 2021
1 parent 90e7449 commit daea559
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/installing.rst
Expand Up @@ -58,7 +58,7 @@ using ``--user`` or fixing potential conflicts if not using virtualenvs.
.. _installing_from_source:
.. _pip3: https://pypi.org/project/pip/
.. _pipx: https://pipxproject.github.io/pipx/
.. _pipx: https://pypa.github.io/pipx/

From Source
-----------
Expand Down
4 changes: 2 additions & 2 deletions docs/usage.rst
Expand Up @@ -30,7 +30,7 @@ As part of the execution, the linter will likely need to create a cache of
installed or mocked roles, collections and modules. This is done inside
``{project_dir}/.cache`` folder. The project directory is either given as a
command line argument, determined by location of the configuration
file, git project top-level directiory or user home directory as fallback.
file, git project top-level directory or user home directory as fallback.
In order to speed-up reruns, the linter does not clean this folder by itself.

If you are using git, you will likely want to add this folder to your
Expand All @@ -57,7 +57,7 @@ CI/CD
-----

If execution under `Github Actions`_ is detected via the presence of
``GITHUB_ACTIONS=true`` and ``GITHUB_WORFLOW=...`` variables, the linter will
``GITHUB_ACTIONS=true`` and ``GITHUB_WORKFLOW=...`` variables, the linter will
also print errors using their `annotation`_ format.

.. _GitHub Actions: https://github.com/features/actions
Expand Down

0 comments on commit daea559

Please sign in to comment.