<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body dir="auto"><div></div><div>Yes developer/code documentation is on our list too. For now we want to focus on the user documentation. That's our top priority but (as always) we are busy with other important things.</div><div><br></div><div>I am afraid without the help of the community we are getting nowhere! If you want to support us, please go the NekDoc issues on GitHub and help to fix them. </div><div><br></div><div>Thanks,</div><div>Stefan</div><div><br></div><div><br>On 9 Sep 2017, at 02:35, "<a href="mailto:nek5000-users@lists.mcs.anl.gov">nek5000-users@lists.mcs.anl.gov</a>" <<a href="mailto:nek5000-users@lists.mcs.anl.gov">nek5000-users@lists.mcs.anl.gov</a>> wrote:<br><br></div><blockquote type="cite"><div>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="Generator" content="Kopano HTML builder 1.0">
<title></title>
<!-- Converted from text/plain format -->
<p><font style="font-family: courier" size="2">
Hi,<br>
I guess connected to that suggestion is the question whether one wants <br>
to have doxygen-type of source documentation. Personally, I would find <br>
that quite useful, and perhaps the easiest way of having source and <br>
documentation in sync.<br>
Best regards,<br>
philipp<br>
<br>
On 2017-09-08 18:39, <a href="mailto:nek5000-users@lists.mcs.anl.gov">nek5000-users@lists.mcs.anl.gov</a> wrote:<br>
> Hi Stefan,<br>
> <br>
> One thing that I think a lot of users (specifically relatively new and unexperienced Nek5000 users) can benefit from is that if there was a 1 or 2 line comment at the beginning of each subroutine that describes what the subroutine does. I realize it might not be practical to go back and modify the existing routines, but it would be nice if future additions/modifications to the code required the contributor to do this.<br>
> <br>
> p.s. I am sometimes guilty of not doing this.. for example - in my most recent PR for multimesh.f. I will address this and include comments in the subroutines that I have modified in multimesh.f in my next PR.<br>
> <br>
> Cheers,<br>
> Ketan<br>
> _______________________________________________<br>
> Nek5000-users mailing list<br>
> <a href="mailto:Nek5000-users@lists.mcs.anl.gov">Nek5000-users@lists.mcs.anl.gov</a><br>
> <a href="https://lists.mcs.anl.gov/mailman/listinfo/nek5000-users">https://lists.mcs.anl.gov/mailman/listinfo/nek5000-users</a><br>
> <br>
_______________________________________________<br>
Nek5000-users mailing list<br>
<a href="mailto:Nek5000-users@lists.mcs.anl.gov">Nek5000-users@lists.mcs.anl.gov</a><br>
<a href="https://lists.mcs.anl.gov/mailman/listinfo/nek5000-users">https://lists.mcs.anl.gov/mailman/listinfo/nek5000-users</a><br>
</font>
</p>
</div></blockquote></body></html>