It's really really hard to keep documentation up to date. The style of
documentation that is provided to the community is spectacular, however
documentation is usually the icing on the cake when it comes to a free
software project.

On top of being incredibly time consuming, documentation gets stale *very*
quickly. So unit tests provide sort of the best form of documentation in
that, if something changes that you don't expect, your tests fails. Then
you go update the tests. In this case, it helps facilitate your
understanding of the code.

If readers go about just writing notes as they go through the unit tests,
its easy to summarize those in order to facilitate readability and to quell
further overhead by reducing the number of questions through maintained
documentation. ;D

On Sat, Oct 17, 2015 at 1:55 PM, Pieter Hintjens <[email protected]> wrote:

> Ooops... sorry.
>
> I'm slowing getting my act together to rewriting the Guide to include
> the security examples.
>
> On Sat, Oct 17, 2015 at 1:25 PM, Brian T. Carcich
> <[email protected]> wrote:
> > Huh?  I see examples/security/*.c, still using zauth_new (zauth_v2.c) and
> > zsocket_new instead of zactor_new and zsock_new, but the tests in zauth
> give
> > a good idea of what to do.
> >
> > Thanks, I should have checked the obvious!
> >
> > On Sat, Oct 17, 2015 at 5:49 AM, Pieter Hintjens <[email protected]> wrote:
> >>
> >> Yes, it's out of date, sorry. There are up to date examples in CZMQ
> >> examples/security.
> >>
> >> On Sat, Oct 17, 2015 at 1:11 AM, Brian T. Carcich
> >> <[email protected]> wrote:
> >> > Hi All,
> >> >
> >> > It looks to me like the
> >> >
> >> >   Using ZeroMQ Security (part 2)
> >> >
> >> > blog entry i.e.
> >> >
> >> >   http://hintjens.com/blog:49
> >> >
> >> > is out of date, as it uses the declared obsolete
> >> >
> >> >   zauth_new(ctx);
> >> >
> >> > call from zauth_v2.c to instantiate a new zauth structure, and The New
> >> > Way
> >> > is something like
> >> >
> >> >   zactor_new(zauth,NULL);
> >> >
> >> > Is that correct?
> >> >
> >> > I am coming at this trying to get something done on a deadline, so
> >> > understanding everything is not my first priority.  Not that failure
> to
> >> > plan
> >> > on my part constitutes an emergency on anyone else's, nor am I asking
> >> > anyone
> >> > to do my homework, but if the answer is a simple yes then I'd
> appreciate
> >> > knowing it so I can take the correct fork in the road the first time.
> >> >
> >> > Thanks,
> >> >
> >> > Brian Carcich
> >> >
> >> > _______________________________________________
> >> > zeromq-dev mailing list
> >> > [email protected]
> >> > http://lists.zeromq.org/mailman/listinfo/zeromq-dev
> >> >
> >> _______________________________________________
> >> zeromq-dev mailing list
> >> [email protected]
> >> http://lists.zeromq.org/mailman/listinfo/zeromq-dev
> >
> >
> >
> > _______________________________________________
> > zeromq-dev mailing list
> > [email protected]
> > http://lists.zeromq.org/mailman/listinfo/zeromq-dev
> >
> _______________________________________________
> zeromq-dev mailing list
> [email protected]
> http://lists.zeromq.org/mailman/listinfo/zeromq-dev
>
_______________________________________________
zeromq-dev mailing list
[email protected]
http://lists.zeromq.org/mailman/listinfo/zeromq-dev

Reply via email to