[clang-tools-extra] 4f01a02 - Fix documentation typos; NFC

Aaron Ballman via cfe-commits cfe-commits at lists.llvm.org
Tue Sep 28 03:57:15 PDT 2021


Author: M Bakinovsky
Date: 2021-09-28T06:56:49-04:00
New Revision: 4f01a02d738b033c10bfed5b47014fc197509a4f

URL: https://github.com/llvm/llvm-project/commit/4f01a02d738b033c10bfed5b47014fc197509a4f
DIFF: https://github.com/llvm/llvm-project/commit/4f01a02d738b033c10bfed5b47014fc197509a4f.diff

LOG: Fix documentation typos; NFC

Fixes bugprone-virtual-near-miss & performance-type-promotion-in-math-fn.

Added: 
    

Modified: 
    clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
    clang-tools-extra/docs/clang-tidy/checks/performance-type-promotion-in-math-fn.rst

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
index 2b2498f6f3584..38ff2d0369937 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
@@ -15,6 +15,6 @@ Example:
   };
 
   struct Derived : Base {
-    virtual funk();
+    virtual void funk();
     // warning: 'Derived::funk' has a similar name and the same signature as virtual method 'Base::func'; did you mean to override it?
   };

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/performance-type-promotion-in-math-fn.rst b/clang-tools-extra/docs/clang-tidy/checks/performance-type-promotion-in-math-fn.rst
index a27a48294ef98..e315a42324719 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/performance-type-promotion-in-math-fn.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/performance-type-promotion-in-math-fn.rst
@@ -6,7 +6,7 @@ performance-type-promotion-in-math-fn
 Finds calls to C math library functions (from ``math.h`` or, in C++, ``cmath``)
 with implicit ``float`` to ``double`` promotions.
 
-For example, warns on ``::sin(0.f)``, because this funciton's parameter is a
+For example, warns on ``::sin(0.f)``, because this function's parameter is a
 double. You probably meant to call ``std::sin(0.f)`` (in C++), or ``sinf(0.f)``
 (in C).
 


        


More information about the cfe-commits mailing list