[zeromq-dev] Language binding guidelines

Martin Sustrik sustrik at 250bpm.com
Tue Mar 2 16:14:03 CET 2010


Hi Vitaly,

> Lots of languages provides documentation strings mechanism for
> functions/macros/etc. This doc is available immediately in REPL or
> even in IDE. At least, Common Lisp and Python does so.
> 
> I'd suggest to return documentation back to bindings when API/Docs
> become almost stable. This is very convenient to see short help while
> you type the code :)

Right. That's the ultimate goal. But, as is widely know, open source 
projects are not very good in writing documentation. It's unreasonable 
to expect that all the language bindings will have perfect 
documentation. Mapping the functions 1:1 to C API provides a fallback 
mechanism that shall allow even users of poorly documented language 
bindings to access relevant documentation.

Martin



More information about the zeromq-dev mailing list