Document tox.ini and its use/tuneup

datalad · Feb 17, 2023 · cd2a860 · cd2a860
1 parent a1d9e60
commit cd2a860
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,8 @@ adjust as necessary. A good approach is to
   "Auto-release on PR merge" workflows by using the code in the
   `datalad/release-action` repository [as described in its
   README](https://github.com/datalad/release-action#command-labels).
+- (Optionally) adjust [`tox.ini`](./tox.ini) for `pytest` and `flake8` options
+  and `tox` environments to use.
 
 You can consider filling in the provided [.zenodo.json](.zenodo.json) file with
 contributor information and [meta data](https://developers.zenodo.org/#representation)

diff --git a/tox.ini b/tox.ini
@@ -1,3 +1,13 @@
+#
+# This file defines common developer helper commands, such as
+# - py3: perform unittest-ing using pytest
+# - lint: codespell the code to avoid typos
+# - flake8: conform code to PEP8 and beyond (not enabled by default)
+# - typing: ensure consistency in type annotations
+#
+# Moveover configuration for pytest and flake8 specified in this file
+# as well, so would be in effect even if used not through tox.
+#
 [tox]
 envlist = py3,lint,typing
 #,flake8