Skip to content

Commit 5049c1c

Browse files
authored
docs: Update analyze-project docs (#30)
* docs: Fix analyze-project action name * docs: Add analyze-project to top-level README.md
1 parent f46b3c5 commit 5049c1c

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
single-sourcing the default Python version for multiple NI Python projects.
99
- [`ni/python-actions/setup-poetry`](setup-poetry): installs Poetry, adds it to the PATH, and caches
1010
it to speed up workflows.
11+
- [`ni/python-actions/analyze-project`](analyze-project): analyzes the code quality of a Python
12+
project using various linters and type checkers.
1113
- [`ni/python-actions/check-project-version`](check-project-version): uses Poetry to get the version
1214
of a Python project and checks that it matches an expected version. Publish workflows can use this
1315
to verify that the release tag matches the version number in `pyproject.toml`.

analyze-project/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `ni/python-actions/analyze-project`
22

3-
The `ni/python-actions/update-project-version` action analyzes the code quality
3+
The `ni/python-actions/analyze-project` action analyzes the code quality
44
of a Python project using various linters and type checkers including
55
ni-python-styleguide, mypy (if the 'mypy' package is installed), and pyright
66
(if the 'pyright' package is installed).

0 commit comments

Comments
 (0)