aboutsummaryrefslogtreecommitdiffstats
path: root/docs/checks/README-virtual-signal.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/checks/README-virtual-signal.md')
-rw-r--r--docs/checks/README-virtual-signal.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/checks/README-virtual-signal.md b/docs/checks/README-virtual-signal.md
new file mode 100644
index 00000000..7d922ce7
--- /dev/null
+++ b/docs/checks/README-virtual-signal.md
@@ -0,0 +1,8 @@
+# virtual-signal
+
+Warns when a signal is virtual.
+Virtual signals make it very hard to read connect statements since people don't
+know they are virtual, and don't expect them to be.
+
+moc also discourages the use of virtual signals, by printing a non-fatal warning:
+`Warning: Signals cannot be declared virtual`