From 40fe68fbbb82640f2b7ee6c6120af3acca15c0f4 Mon Sep 17 00:00:00 2001
From: umarcor <unai.martinezcorral@ehu.eus>
Date: Tue, 30 Nov 2021 13:13:16 +0100
Subject: [PATCH] readme: add example mypy commands

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index f04821a..de87c38 100644
--- a/README.md
+++ b/README.md
@@ -97,6 +97,30 @@ As shown in the screenshot above, the expected order is:
     results to Codecov and Codacy.
   - [StaticTypeCheck](.github/workflows/StaticTypeCheck.yml): collect static type check result with `mypy`, and
     optionally upload results as an HTML report.
+    Example `commands`:
+
+    1. Regular package
+
+      ```yml
+      commands: mypy --html-report htmlmypy -p ToolName
+      ```
+
+    2. Parent namespace package
+
+      ```yml
+      commands: |
+        touch Parent/__init__.py
+        mypy --html-report htmlmypy -p ToolName
+      ```
+
+    3. Child namespace package
+
+      ```yml
+      commands: |
+        cd Parent
+        mypy --html-report ../htmlmypy -p ToolName
+      ```
+
   - [VerifyDocs](.github/workflows/VerifyDocs.yml): extract code examples from the README and test.
 - Packaging and releasing:
   - [Release](.github/workflows/Release.yml): publish GitHub Release.