[sr-dev] Freeze rules and undoing a needless string copy

Olle E. Johansson oej at edvina.net
Fri Sep 9 07:55:11 CEST 2011


8 sep 2011 kl. 23:58 skrev Henning Westerholt:

> Only bug fixes in code, documentation or utilities are allowed.

So while you are waiting you can spend time making sure

 - That the documentation is up-to-date with your cool new code
 - That all the new core functions and variables are part of the wiki cookbook and docs
 - That you have configuration examples committed

Important question you need to ask yourself about your docs is not only if it's a good reference, but also if it clearly states the problem you are trying to solve. A reference just explains parameters - but that's not enough, you also need to explain why someone should use this module/function/pv and what's cool with it.

When your done with your own docs, feel free not to play games but to check existing documentation too.

Thanks - enjoy writing the docs before you restart coding new stuff after code freeze!

/O
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sip-router.org/pipermail/sr-dev/attachments/20110909/4cb3128f/attachment.htm>


More information about the sr-dev mailing list