Document commands

kgryte · kgryte · commit 58cf698a646e · 2018-04-29T14:15:32.000-07:00
diff --git a/tools/make/lib/lint/README.md b/tools/make/lib/lint/README.md
@@ -322,6 +322,109 @@ This command is useful when wanting to lint a list of Julia files generated by s
 
 * * *
 
+### Python
+
+#### lint-python
+
+Lints Python files.
+
+<!-- run-disable -->
+
+```bash
+$ make lint-python
+```
+
+The command supports the environment variables supported by each context-specific (`lint-python-<context>`) command documented below.
+
+This command is useful when wanting to glob for files, irrespective of context, for a particular package in order to lint all contained Python files.
+
+#### lint-python-src
+
+Lints Python source files.
+
+<!-- run-disable -->
+
+```bash
+$ make lint-python-src
+```
+
+The command supports the following environment variables:
+
+-   **PYTHON_SOURCES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+-   **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+
+This command is useful when wanting to glob for Python source files (e.g., lint all Python source files for a particular package).
+
+#### lint-python-tests-fixtures
+
+Lints Python test fixture files.
+
+<!-- run-disable -->
+
+```bash
+$ make lint-python-tests-fixtures
+```
+
+The command supports the following environment variables:
+
+-   **PYTHON_TESTS_FIXTURES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+-   **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+
+This command is useful when wanting to glob for Python test fixture files (e.g., lint all Python test fixture files for a particular package).
+
+#### lint-python-examples
+
+Lints Python examples files.
+
+<!-- run-disable -->
+
+```bash
+$ make lint-python-examples
+```
+
+The command supports the following environment variables:
+
+-   **PYTHON_EXAMPLES_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+-   **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+
+This command is useful when wanting to glob for Python examples files (e.g., lint all Python examples files for a particular package).
+
+#### lint-python-benchmarks
+
+Lints Python benchmark files.
+
+<!-- run-disable -->
+
+```bash
+$ make lint-python-src
+```
+
+The command supports the following environment variables:
+
+-   **PYTHON_BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
+-   **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+
+This command is useful when wanting to glob for Python benchmark files (e.g., lint all Python benchmark files for a particular package).
+
+#### lint-python-files
+
+Lints a specified list of Python files.
+
+<!-- run-disable -->
+
+```bash
+$ make lint-python-files FILES='/foo/file.py /bar/file.py'
+```
+
+The command supports the following environment variables:
+
+-   **FILES**: list of Python files.
+-   **FAST_FAIL**: flag indicating whether to stop linting upon encountering a lint error.
+
+This command is useful when wanting to lint a list of Python files generated by some other command (e.g., a list of changed Python files obtained via `git diff`).
+
+* * *
+
 ### Configuration Files
 
 #### lint-conf
