diff --git a/docs/checks/README-heap-allocated-small-trivial-type.md b/docs/checks/README-heap-allocated-small-trivial-type.md index 0996a86..b634535 100644 --- a/docs/checks/README-heap-allocated-small-trivial-type.md +++ b/docs/checks/README-heap-allocated-small-trivial-type.md @@ -1,9 +1,12 @@ # heap-allocated-small-trivial-type Warns when you're allocating small trivially copyable/destructible types on the heap. Example: ``` auto p = new QPoint(1, 1); + /// ... p just used locally in the scope ``` -Unneeded memory allocations are costly. +Unneeded memory allocations are costly. Make sure there's no change in behaviour +before fixing these warnings. This check is not enabled by default since there's +a certain amount of known false-positives.