Deploying to gh-pages from @ 11b7799 🚀

melexis · Oct 21, 2024 · 3fede9e · 3fede9e
1 parent 3babda4
commit 3fede9e
Show file tree

Hide file tree

Showing 22 changed files with 204 additions and 141 deletions.
diff --git a/_modules/index.html b/_modules/index.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; warning-plugin 5.5.0 documentation</title>
+    <title>Overview: module code &#8212; warning-plugin 5.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css" />
 
@@ -30,7 +30,7 @@
       <h3>Navigation</h3>
       <ul>
         <li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
-        <li><a href="../index.html">warning-plugin-5.5.0</a> &#187;</li> 
+        <li><a href="../index.html">warning-plugin-5.5.1</a> &#187;</li> 
       </ul>
     </div>
 
@@ -111,7 +111,7 @@ <h3>Navigation</h3>
 
     <div class="footer" role="contentinfo">
         &#169; Copyright 2017-2019, Bavo Van Achte.
-      Last updated on Sep 26, 2024.
+      Last updated on Oct 21, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>

diff --git a/_modules/mlx/warnings/exceptions.html b/_modules/mlx/warnings/exceptions.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mlx.warnings.exceptions &#8212; warning-plugin 5.5.0 documentation</title>
+    <title>mlx.warnings.exceptions &#8212; warning-plugin 5.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />
 
@@ -30,7 +30,7 @@
       <h3>Navigation</h3>
       <ul>
         <li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
-        <li><a href="../../../index.html">warning-plugin-5.5.0</a> &#187;</li>
+        <li><a href="../../../index.html">warning-plugin-5.5.1</a> &#187;</li>
           <li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>
@@ -107,7 +107,7 @@ <h3>Navigation</h3>
 
     <div class="footer" role="contentinfo">
         &#169; Copyright 2017-2019, Bavo Van Achte.
-      Last updated on Sep 26, 2024.
+      Last updated on Oct 21, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>

diff --git a/_modules/mlx/warnings/junit_checker.html b/_modules/mlx/warnings/junit_checker.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mlx.warnings.junit_checker &#8212; warning-plugin 5.5.0 documentation</title>
+    <title>mlx.warnings.junit_checker &#8212; warning-plugin 5.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />
 
@@ -30,7 +30,7 @@
       <h3>Navigation</h3>
       <ul>
         <li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
-        <li><a href="../../../index.html">warning-plugin-5.5.0</a> &#187;</li>
+        <li><a href="../../../index.html">warning-plugin-5.5.1</a> &#187;</li>
           <li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>
@@ -173,7 +173,7 @@ <h3>Navigation</h3>
 
     <div class="footer" role="contentinfo">
         &#169; Copyright 2017-2019, Bavo Van Achte.
-      Last updated on Sep 26, 2024.
+      Last updated on Oct 21, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>

diff --git a/_modules/mlx/warnings/polyspace_checker.html b/_modules/mlx/warnings/polyspace_checker.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mlx.warnings.polyspace_checker &#8212; warning-plugin 5.5.0 documentation</title>
+    <title>mlx.warnings.polyspace_checker &#8212; warning-plugin 5.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />
 
@@ -30,7 +30,7 @@
       <h3>Navigation</h3>
       <ul>
         <li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
-        <li><a href="../../../index.html">warning-plugin-5.5.0</a> &#187;</li>
+        <li><a href="../../../index.html">warning-plugin-5.5.1</a> &#187;</li>
           <li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>
@@ -67,9 +67,16 @@ <h1>Source code for mlx.warnings.polyspace_checker</h1><div class="highlight"><p
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">verbose</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_cq_description_template</span> <span class="o">=</span> <span class="n">Template</span><span class="p">(</span><span class="s1">&#39;Polyspace: $check&#39;</span><span class="p">)</span>
 
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">cq_findings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&#39;&#39;&#39; List[dict]: list of code quality findings&#39;&#39;&#39;</span>
+        <span class="k">for</span> <span class="n">checker</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_cq_findings</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">checker</span><span class="o">.</span><span class="n">cq_findings</span><span class="p">)</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cq_findings</span>
+
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">counted_warnings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&#39;&#39;&#39; List: list of counted warnings (str) &#39;&#39;&#39;</span>
+<span class="w">        </span><span class="sd">&#39;&#39;&#39;List[str]: list of counted warnings&#39;&#39;&#39;</span>
         <span class="n">all_counted_warnings</span> <span class="o">=</span> <span class="p">[]</span>
         <span class="k">for</span> <span class="n">checker</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="p">:</span>
             <span class="n">all_counted_warnings</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">checker</span><span class="o">.</span><span class="n">counted_warnings</span><span class="p">)</span>
@@ -196,7 +203,6 @@ <h1>Source code for mlx.warnings.polyspace_checker</h1><div class="highlight"><p
                     <span class="n">check_value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
                     <span class="n">checker</span> <span class="o">=</span> <span class="n">PolyspaceFamilyChecker</span><span class="p">(</span><span class="n">family_value</span><span class="p">,</span> <span class="n">column_name</span><span class="p">,</span> <span class="n">check_value</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">verbose</span><span class="p">)</span>
                     <span class="n">checker</span><span class="o">.</span><span class="n">parse_config</span><span class="p">(</span><span class="n">check</span><span class="p">)</span>
-                    <span class="n">checker</span><span class="o">.</span><span class="n">cq_findings</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cq_findings</span>  <span class="c1"># share object with sub-checkers</span>
                     <span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">checker</span><span class="p">)</span>
                 <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">column_name</span> <span class="ow">and</span> <span class="n">check_value</span><span class="p">):</span>
                     <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
@@ -377,7 +383,7 @@ <h3>Navigation</h3>
 
     <div class="footer" role="contentinfo">
         &#169; Copyright 2017-2019, Bavo Van Achte.
-      Last updated on Sep 26, 2024.
+      Last updated on Oct 21, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>

diff --git a/_modules/mlx/warnings/regex_checker.html b/_modules/mlx/warnings/regex_checker.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mlx.warnings.regex_checker &#8212; warning-plugin 5.5.0 documentation</title>
+    <title>mlx.warnings.regex_checker &#8212; warning-plugin 5.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />
 
@@ -30,7 +30,7 @@
       <h3>Navigation</h3>
       <ul>
         <li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
-        <li><a href="../../../index.html">warning-plugin-5.5.0</a> &#187;</li>
+        <li><a href="../../../index.html">warning-plugin-5.5.1</a> &#187;</li>
           <li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>
@@ -161,12 +161,19 @@ <h1>Source code for mlx.warnings.regex_checker</h1><div class="highlight"><pre>
 
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">counted_warnings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&#39;&#39;&#39; List: list of counted warnings (str) &#39;&#39;&#39;</span>
+<span class="w">        </span><span class="sd">&#39;&#39;&#39; List[str]: list of counted warnings&#39;&#39;&#39;</span>
         <span class="n">all_counted_warnings</span> <span class="o">=</span> <span class="p">[]</span>
         <span class="k">for</span> <span class="n">checker</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
             <span class="n">all_counted_warnings</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">checker</span><span class="o">.</span><span class="n">counted_warnings</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">all_counted_warnings</span>
 
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">cq_findings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&#39;&#39;&#39; List[dict]: list of code quality findings&#39;&#39;&#39;</span>
+        <span class="k">for</span> <span class="n">checker</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_cq_findings</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">checker</span><span class="o">.</span><span class="n">cq_findings</span><span class="p">)</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cq_findings</span>
+
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">cq_description_template</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&#39;&#39;&#39; Template: string.Template instance based on the configured template string &#39;&#39;&#39;</span>
@@ -243,7 +250,6 @@ <h1>Source code for mlx.warnings.regex_checker</h1><div class="highlight"><pre>
                     <span class="n">checker</span><span class="o">.</span><span class="n">maximum</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">maximum</span><span class="p">)</span>
                 <span class="k">if</span> <span class="n">minimum</span> <span class="o">:=</span> <span class="n">checker_config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;min&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">):</span>
                     <span class="n">checker</span><span class="o">.</span><span class="n">minimum</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">minimum</span><span class="p">)</span>
-                <span class="n">checker</span><span class="o">.</span><span class="n">cq_findings</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cq_findings</span>  <span class="c1"># share object with sub-checkers</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="p">[</span><span class="n">classification_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">checker</span>
             <span class="k">else</span><span class="p">:</span>
                 <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;WARNING: Unrecognized classification </span><span class="si">{</span><span class="n">classification</span><span class="si">!r}</span><span class="s2">&quot;</span><span class="p">)</span>
@@ -432,7 +438,7 @@ <h3>Navigation</h3>
 
     <div class="footer" role="contentinfo">
         &#169; Copyright 2017-2019, Bavo Van Achte.
-      Last updated on Sep 26, 2024.
+      Last updated on Oct 21, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>

diff --git a/_modules/mlx/warnings/robot_checker.html b/_modules/mlx/warnings/robot_checker.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mlx.warnings.robot_checker &#8212; warning-plugin 5.5.0 documentation</title>
+    <title>mlx.warnings.robot_checker &#8212; warning-plugin 5.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />
 
@@ -30,7 +30,7 @@
       <h3>Navigation</h3>
       <ul>
         <li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
-        <li><a href="../../../index.html">warning-plugin-5.5.0</a> &#187;</li>
+        <li><a href="../../../index.html">warning-plugin-5.5.1</a> &#187;</li>
           <li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>
@@ -62,7 +62,7 @@ <h1>Source code for mlx.warnings.robot_checker</h1><div class="highlight"><pre>
 
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">counted_warnings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&#39;&#39;&#39; List: list of counted warnings (str) &#39;&#39;&#39;</span>
+<span class="w">        </span><span class="sd">&#39;&#39;&#39;List[str]: list of counted warnings&#39;&#39;&#39;</span>
         <span class="n">all_counted_warnings</span> <span class="o">=</span> <span class="p">[]</span>
         <span class="k">for</span> <span class="n">checker</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="p">:</span>
             <span class="n">all_counted_warnings</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">checker</span><span class="o">.</span><span class="n">counted_warnings</span><span class="p">)</span>
@@ -262,7 +262,7 @@ <h3>Navigation</h3>
 
     <div class="footer" role="contentinfo">
         &#169; Copyright 2017-2019, Bavo Van Achte.
-      Last updated on Sep 26, 2024.
+      Last updated on Oct 21, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>