[Nek5000-users] Feedback Documentation

[nek5000-users at lists.mcs.anl.gov]

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.

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. 

Thanks,
Stefan


On 9 Sep 2017, at 02:35, "nek5000-users at lists.mcs.anl.gov <mailto:nek5000-users at lists.mcs.anl.gov> " <nek5000-users at lists.mcs.anl.gov <mailto:nek5000-users at lists.mcs.anl.gov> > wrote:

Hi,
I guess connected to that suggestion is the question whether one wants 
to have doxygen-type of source documentation. Personally, I would find 
that quite useful, and perhaps the easiest way of having source and 
documentation in sync.
Best regards,
philipp

On 2017-09-08 18:39, nek5000-users at lists.mcs.anl.gov <mailto:nek5000-users at lists.mcs.anl.gov> wrote:
> Hi Stefan,
> 
> 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.
> 
> 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.
> 
> Cheers,
> Ketan
> _______________________________________________
> Nek5000-users mailing list
> Nek5000-users at lists.mcs.anl.gov <mailto:Nek5000-users at lists.mcs.anl.gov> 
> https://lists.mcs.anl.gov/mailman/listinfo/nek5000-users
> 
_______________________________________________
Nek5000-users mailing list
Nek5000-users at lists.mcs.anl.gov <mailto:Nek5000-users at lists.mcs.anl.gov> 
https://lists.mcs.anl.gov/mailman/listinfo/nek5000-users

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/nek5000-users/attachments/20170909/592230e9/attachment.html>