You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<h1>Coding quality<aclass="headerlink" href="#coding-quality" title="Permalink to this headline"></a></h1>
106
+
<h1>Coding quality<aclass="headerlink" href="#coding-quality" title="Permalink to this heading"></a></h1>
106
107
<p>I value software quality. Higher quality software has fewer defects, better security, and better performance, which leads to happier users who can work more effectively.
107
108
Code reviews are an effective method for improving software quality. McConnell (2004) suggests that unit testing finds approximately 25% of defects, function testing 35%, integration testing 45%, and code review 55-60%.
108
109
While this means that none of these methods are good enough on their own and that they should be combined, clearly code review is an essential tool here.</p>
109
110
<p>This library is therefore developed with several techniques, such as coding styling, low complexity, docstrings, reviews, and unit tests.
110
111
Such conventions are helpfull to improve the quality, make the code cleaner and more understandable but alos to trace future bugs, and spot syntax errors.</p>
111
112
<sectionid="library">
112
-
<h2>library<aclass="headerlink" href="#library" title="Permalink to this headline"></a></h2>
113
+
<h2>library<aclass="headerlink" href="#library" title="Permalink to this heading"></a></h2>
113
114
<p>The file structure of the generated package looks like:</p>
@@ -139,13 +140,13 @@ <h2>library<a class="headerlink" href="#library" title="Permalink to this headli
139
140
</div>
140
141
</section>
141
142
<sectionid="style">
142
-
<h2>Style<aclass="headerlink" href="#style" title="Permalink to this headline"></a></h2>
143
+
<h2>Style<aclass="headerlink" href="#style" title="Permalink to this heading"></a></h2>
143
144
<p>This library is compliant with the PEP-8 standards.
144
145
PEP stands for Python Enhancement Proposal and sets a baseline for the readability of Python code.
145
146
Each public function contains a docstring that is based on numpy standards.</p>
146
147
</section>
147
148
<sectionid="complexity">
148
-
<h2>Complexity<aclass="headerlink" href="#complexity" title="Permalink to this headline"></a></h2>
149
+
<h2>Complexity<aclass="headerlink" href="#complexity" title="Permalink to this heading"></a></h2>
149
150
<p>This library has been developed by using measures that help decreasing technical debt.
150
151
Developing software with low(er) technical dept may take extra development time, but has many advantages:</p>
151
152
<ulclass="simple">
@@ -156,7 +157,7 @@ <h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this
156
157
</ul>
157
158
</section>
158
159
<sectionid="unit-tests">
159
-
<h2>Unit tests<aclass="headerlink" href="#unit-tests" title="Permalink to this headline"></a></h2>
160
+
<h2>Unit tests<aclass="headerlink" href="#unit-tests" title="Permalink to this heading"></a></h2>
160
161
<p>The use of unit tests is essential to garantee a consistent output of developed functions.
161
162
The following tests are secured using <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">tests.test_treeplot()</span></code>:</p>
0 commit comments