aboutsummaryrefslogtreecommitdiffstats
path: root/docs/checks/README-qstring-varargs.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/checks/README-qstring-varargs.md')
-rw-r--r--docs/checks/README-qstring-varargs.md14
1 files changed, 6 insertions, 8 deletions
diff --git a/docs/checks/README-qstring-varargs.md b/docs/checks/README-qstring-varargs.md
index aa029e46..8bfa6182 100644
--- a/docs/checks/README-qstring-varargs.md
+++ b/docs/checks/README-qstring-varargs.md
@@ -2,12 +2,10 @@
This implements the equivalent of `-Wnon-pod-varargs` but only for `QString`.
-This check is disabled by default and is only useful in cases where you don't want
-to enable `-Wnon-pod-varargs`. For example on projects with thousands of benign warnings
-(like with CString), where you might only want to fix the `QString` cases.
-
-#### Example
- QString s = (...)
- LogError("error %s", s);
-
+This check is disabled by default and is only useful in cases where you don't want to enable `-Wnon-pod-varargs`. For example on projects with thousands of benign warnings (like with MFC's `CString`), where you might only want to fix the `QString` cases.
+Example
+```
+QString s = (...)
+LogError("error %s", s);
+```