Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

Hello. On 24/11/16 23:33, Gustavo Sverzut Barbieri wrote: > Plus reference to events, as it will be hard to add afterwards. See all > io/net where I try to document their relation to methods Jpeg also raised this point before. Daniel is looking into this. AFAIK he was thinking about the best

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

Plus reference to events, as it will be hard to add afterwards. See all io/net where I try to document their relation to methods Also, it would be nice to extend or replace docs for methods we implement. Clear user is "dial(address)" where I'd like to document address string encoding for each

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

Hello. On 24/11/16 19:38, Felipe Magno de Almeida wrote: > On Thu, Nov 24, 2016 at 1:35 PM, Stefan Schmidt > wrote: >> Hello. > > [snip] > >> With the last batch I pushed today we have 100% doc coverage in our eo >> files! :) >> >> Now we need to keep it like this,

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

On Thu, Nov 24, 2016 at 1:35 PM, Stefan Schmidt wrote: > Hello. [snip] > With the last batch I pushed today we have 100% doc coverage in our eo > files! :) > > Now we need to keep it like this, please. :) Great job! Why not have Daniel add an error for functions that

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

On Thursday 24 November 2016 16:35, Stefan Schmidt wrote : > Hello. > > On 25/10/16 10:15, Stefan Schmidt wrote: > > Hello. > > > > On 25/10/16 05:04, Carsten Haitzler (The Rasterman) wrote: > >> On Sat, 22 Oct 2016 00:43:30 +0200 Stefan Schmidt > >> said: > >> > >>>

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

Hello. On 25/10/16 10:15, Stefan Schmidt wrote: > Hello. > > On 25/10/16 05:04, Carsten Haitzler (The Rasterman) wrote: >> On Sat, 22 Oct 2016 00:43:30 +0200 Stefan Schmidt >> said: >> >>> Hello. >>> >>> TL;DR: If you are committing new eo files I expect them to have

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

On Tue, 25 Oct 2016 10:15:52 +0200 Stefan Schmidt said: > Hello. > > On 25/10/16 05:04, Carsten Haitzler (The Rasterman) wrote: > > On Sat, 22 Oct 2016 00:43:30 +0200 Stefan Schmidt > > said: > > > >> Hello. > >> > >> TL;DR: If you are committing

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

Hello. On 25/10/16 05:04, Carsten Haitzler (The Rasterman) wrote: > On Sat, 22 Oct 2016 00:43:30 +0200 Stefan Schmidt > said: > >> Hello. >> >> TL;DR: If you are committing new eo files I expect them to have full >> docs from now one. Also help with the ones you are

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

On Sat, 22 Oct 2016 00:43:30 +0200 Stefan Schmidt said: > Hello. > > TL;DR: If you are committing new eo files I expect them to have full > docs from now one. Also help with the ones you are currently working on. this is actually looking pretty decent below now in

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

Hello. On 24/10/16 10:27, Stefan Schmidt wrote: > Hello. > > On 24/10/16 05:15, Jean-Philippe André wrote: >> Hi Stefan, >> >> On 22 October 2016 at 07:43, Stefan Schmidt wrote: >> >> I assume gendoc.lua should be run against /share/eolian/include >> rather than the

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

Hello. On 24/10/16 11:27, Jean-Philippe André wrote: > Hey Stefan, > > On 24 October 2016 at 17:27, Stefan Schmidt wrote: >> >> [...] >>> Also, I would argue that quite often an obvious parameter, getter return, >>> etc... doesn't need to be documented, so the goal

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

Hey Stefan, On 24 October 2016 at 17:27, Stefan Schmidt wrote: > > [...] > > Also, I would argue that quite often an obvious parameter, getter return, > > etc... doesn't need to be documented, so the goal shouldn't be 100% > > coverage :) > > I expected that someone will

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

Hello. On 24/10/16 05:15, Jean-Philippe André wrote: > Hi Stefan, > > On 22 October 2016 at 07:43, Stefan Schmidt wrote: > >> Hello. >> >> TL;DR: If you are committing new eo files I expect them to have full >> docs from now one. Also help with the ones you are currently

Re: [E-devel] Making documentation for all elements of a eo file mandatory for new files

Hi Stefan, On 22 October 2016 at 07:43, Stefan Schmidt wrote: > Hello. > > TL;DR: If you are committing new eo files I expect them to have full > docs from now one. Also help with the ones you are currently working on. > > Longer version: > If you look at the commit log

[E-devel] Making documentation for all elements of a eo file mandatory for new files

Hello. TL;DR: If you are committing new eo files I expect them to have full docs from now one. Also help with the ones you are currently working on. Longer version: If you look at the commit log you can see that I started another crusade on getting our doc coverage for eo files. Right now we