[zeromq-dev] Docs

john skaller skaller at users.sourceforge.net
Mon Jan 16 10:12:39 CET 2012


On 16/01/2012, at 7:56 PM, john skaller wrote:

>> 
>> If you have an idea how to fix the docs, feel free to suggest a patch.
> 
> 
> I can outline an idea for discussion (or make a patch .. are the docs on GitHub?)
> 
> I would define three terms (not necessarily the ones I use here,
> they just "make sense semantically" to me):


BTW: I believe the structure used in the C++ Standard is quite good.
It breaks a bit from Posix documentation, but it agrees with what most
programmers understand: C++ Standard uses pre- and post-conditions,
I think they're annotated like: "Requires" and "Effects".

Using that structure is good IMHO, because there's a discipline now
for the docs: make sure there's a Requires and Effects clause
for each function.

--
john skaller
skaller at users.sourceforge.net




More information about the zeromq-dev mailing list