aboutsummaryrefslogtreecommitdiffhomepage
path: root/Makefile
diff options
context:
space:
mode:
authorJ08nY2021-04-11 14:16:57 +0200
committerJ08nY2021-04-11 14:16:57 +0200
commit942c0fb9d6fcbff7c91c553211cc81c7e0939e4e (patch)
tree1df80da6030019ef2a7490d2b2050a7d4b9a83ec /Makefile
parenta2e01e037fcde3e63571633e94156e324a4f2299 (diff)
downloadpyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.tar.gz
pyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.tar.zst
pyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.zip
Make docstring style changes as per pydocstyle.
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile6
1 files changed, 5 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 326e80e..bee57d7 100644
--- a/Makefile
+++ b/Makefile
@@ -30,6 +30,9 @@ codestyle:
codestyle-all:
flake8 --extend-ignore=E501,F405,F403,F401,E126,E203 pyecsca test
+docstyle:
+ pydocstyle pyecsca --ignore=D1,D203,D212 -e --count
+
black:
black pyecsca
@@ -58,6 +61,7 @@ help:
@echo " - typecheck-all: Use mypy to verify the use of types in pyecsca and in tests."
@echo " - codestyle: Use flake8 to check codestyle in pyecsca."
@echo " - codestyle-all: Use flake8 to check codestyle in pyecsca and in tests."
+ @echo " - docstyle: Use pydocstyle to check format of docstrings."
@echo " - black: Run black on pyecsca sources (will transform them inplace)."
@echo " - black-all: Run black on pyecsca sources and tests (will transform them inplace)."
@echo " - perf: Run performance measurements (prints results and stores them in .perf/)."
@@ -65,4 +69,4 @@ help:
@echo " - docs: Build docs using sphinx."
@echo " - help: Show this help."
-.PHONY: test test-plots test-all typecheck typecheck-all codestyle codestyle-all black black-all perf doc-coverage docs
+.PHONY: test test-plots test-all typecheck typecheck-all codestyle codestyle-all docstyle black black-all perf doc-coverage docs