aboutsummaryrefslogtreecommitdiffstats
path: root/docs/checks/README-static-pmf.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/checks/README-static-pmf.md')
-rw-r--r--docs/checks/README-static-pmf.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/checks/README-static-pmf.md b/docs/checks/README-static-pmf.md
index e27e7b6c..39dbfedb 100644
--- a/docs/checks/README-static-pmf.md
+++ b/docs/checks/README-static-pmf.md
@@ -1,9 +1,10 @@
# static-pmf
-Warns when storing a pointer to QObject member function into a static variable.
-Passing such variable to a connect is known to fail when using MingW.
+Warns when storing a pointer to `QObject` member function into a static variable and passing it to a connect statement.
+This is known to make the connect statement fail when the code is built with **MingW**.
Example:
-
+```
static auto pmf = &QObject::destroyed;
QCOMPARE(pmf, &QObject::destroyed); // fails
+```