<div dir="ltr"><div class="gmail_extra"><div class="gmail_quote">On 23 September 2016 at 11:17, Loïc Hoguin <span dir="ltr"><<a href="mailto:essen@ninenines.eu" target="_blank">essen@ninenines.eu</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class="">On 09/23/2016 10:36 AM, Lutz Behnke wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
I would propose a position specific to the reference documentation:<br>
<br>
8) Put the documentation in the source code. Use edoc (or similar new<br>
tool).<br>
</blockquote>
<br></span>
And I would strongly advise against that.<br>
<br></blockquote><div><br></div><div>I definitely agree with Loïc here but from the programmers viewpoint. When working with the code I need (good) documentation which describes what the code is doing from the internal POV. I definitely DON'T need documentation for the user on how to use and what it means and examples and ... . That just clutters up the page for me writing/maintaining the code.<br><br></div><div>Note that I am NOT saying the user doesn't need all that, the user definitely does need/require all that, but it should be somewhere else not mixed in with the code.<br><br></div><div>Robert<br><br></div></div></div></div>