diff options
| author | Sergio Martins <iamsergio@gmail.com> | 2018-07-10 08:17:21 +0100 |
|---|---|---|
| committer | Sergio Martins <iamsergio@gmail.com> | 2018-07-10 08:17:24 +0100 |
| commit | 5407f16d71ab9a16e59e9b4007b86db18996b4c1 (patch) | |
| tree | 5eecaa6caa878fc1d1274c9d12b97d9b571e2abd /docs/checks | |
| parent | b63df9f91fcec3e0e18684c42f019525f5684927 (diff) | |
const-signal-or-slot: Improve readme
Clarify what's bad about const signals
Diffstat (limited to 'docs/checks')
| -rw-r--r-- | docs/checks/README-const-signal-or-slot.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/checks/README-const-signal-or-slot.md b/docs/checks/README-const-signal-or-slot.md index 9a3e71b2..21020a39 100644 --- a/docs/checks/README-const-signal-or-slot.md +++ b/docs/checks/README-const-signal-or-slot.md @@ -3,7 +3,12 @@ Warns when a signal or non-void slot is const. This aims to prevent unintentionally marking a getter as slot, or connecting to -the wrong method. For signals, it's just pointless to mark them as const. +the wrong method. + +For signals it's more of a minor issue. Prevents you from emitting signals from +const methods, as these methods shouldn't change state, and a signal implies state +was changed. Helps minimizing having global state (which is the only state you can +change from a const method). Warns for the following cases: |