<html>#2469: None oft the thorns in WVUThorns_Diagnostics have documentation
<table style='border-spacing: 1ex 0pt; '>
<tr><td style='text-align:right'> Reporter:</td><td>Roland Haas</td></tr>
<tr><td style='text-align:right'> Status:</td><td>new</td></tr>
<tr><td style='text-align:right'>Milestone:</td><td></td></tr>
<tr><td style='text-align:right'> Version:</td><td></td></tr>
<tr><td style='text-align:right'> Type:</td><td>bug</td></tr>
<tr><td style='text-align:right'> Priority:</td><td>major</td></tr>
<tr><td style='text-align:right'>Component:</td><td>EinsteinToolkit thorn</td></tr>
</table>
<p>All thorns in the <code>WVUThorns_Diagnostics</code> arrangement are lacking a file <code>documentation.tex</code> and thus</p>
<ul>
<li>don’t show up on <a data-is-external-link="true" href="http://einsteintoolkit.org/documentation/ThornGuide.php" rel="nofollow">http://einsteintoolkit.org/documentation/ThornGuide.php</a></li>
<li>are undocumented</li>
</ul>
<p>Having documentation is a requirement for inclusion in the ET (<a data-is-external-link="true" href="http://einsteintoolkit.org/contribute.html" rel="nofollow">http://einsteintoolkit.org/contribute.html</a>)</p>
<blockquote>
<p>* Components should be of sufficient quality to be used for peer-reviewed and published science. This includes a basic standard of software engineering, <strong>documentation of the software</strong> including algorithms and methods, tutorials and examples, and self-tests to demonstrate that the software works correctly.</p>
</blockquote>
<p>The source code uses an misleading extension for C source files namely it used <code>.C</code> (uppercase letter “c”) which in GNU make (and Cactus) is used for C++ files so is compiled with g++ (but is not recommended since it assumes a file system that distinguishes and preserves case): <a data-is-external-link="true" href="https://www.gnu.org/software/make/manual/html_node/Catalogue-of-Rules.html#index-_002eC" rel="nofollow">https://www.gnu.org/software/make/manual/html_node/Catalogue-of-Rules.html#index-_002eC</a> None of the files seem to actually be C++ code eg <code>VolumeIntegrals_GRMHD/src/perform_integration_sum_global.C</code> contains <code>void VI_GRMHD_DoSum(CCTK_ARGUMENTS)</code> which is not typically used in C++ code (though the required <code>extern “C”</code> is already provided by Cactus' prototype (so that it is actually found by <code>schedule.ccl</code>).</p>
<p>--<br/>
Ticket URL: <a href='https://bitbucket.org/einsteintoolkit/tickets/issues/2469/none-oft-the-thorns-in'>https://bitbucket.org/einsteintoolkit/tickets/issues/2469/none-oft-the-thorns-in</a></p>
</html>