<html><head><meta http-equiv="Content-Type" content="text/html charset=utf-8"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class="">Hi Ale<br class=""><div><blockquote type="cite" class=""><div class="">On 19 Aug 2015, at 09:41, Alessandro Pasotti <<a href="mailto:apasotti@gmail.com" class="">apasotti@gmail.com</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><div dir="ltr" class=""><div class="gmail_extra"><div class="gmail_quote">2015-08-18 23:19 GMT+02:00 Tim Sutton <span dir="ltr" class=""><<a href="mailto:tim@qgis.org" target="_blank" class="">tim@qgis.org</a>></span>:<br class=""><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div style="word-wrap:break-word" class=""><span class="">Hi all<br class=""><br class="">In the last few years we have been steadily improving the amount of funding we are able to accumulate in the QGIS project. Our goal in obtaining funding is always to 'make QGIS better'. Up until now we have focussed funding on high profile aspects of the project: Funding regular hackfests, paying for bug fixing work prior to releases, funding infrastructure such as servers, domain name registrations etc. <br class=""><br class="">With improved funding levels we now have the opportunity to also start addressing some of the many less obvious components of QGIS that badly need attention, but often don't attract volunteers. In our July 2015 PSC meeting it was agreed that we would start this initiative by funding one or more developers to improve the python documentation in QGIS. If you are interested in working on this, please be so kind as to visit the form [1] that we have set up for this.<br class=""><br class=""></span><span class=""><br class=""></span><div class="">[1] <a href="http://goo.gl/forms/WRGSvWHkBb" target="_blank" class="">http://goo.gl/forms/WRGSvWHkBb</a></div><div class=""><br class=""></div><div class="">Regards</div><div class=""><br class=""></div><div class="">Tim</div><br class=""></div></blockquote><div class=""><br class=""><br class=""></div><div class="">Hi Tim,<br class=""><br class=""></div><div class="">Thank you for writing this proposal: QGIS developer documentation really needs some more love :)<br class=""></div></div></div></div></div></blockquote><div><br class=""></div><div>Yes it does!</div><br class=""><blockquote type="cite" class=""><div class=""><div dir="ltr" class=""><div class="gmail_extra"><div class="gmail_quote"><div class=""><br class=""></div><div class="">While reading the form, I noticed that one of the goals is <br class=""><br class="">* port the cookbook content over to the API documentation<br class=""><br class=""></div><div class="">Does this mean the end of the cookbook? I hope not!<br class=""></div></div></div></div></div></blockquote><div><br class=""></div><blockquote type="cite" class=""><div class=""><div dir="ltr" class=""><div class="gmail_extra"><div class="gmail_quote"><div class=""><br class=""></div><div class="">IMHO the purpose of the cookbook is not to be a full API reference but a collection of small tutorials (recipes), with some introductory material.<br class=""><br class=""></div><div class="">I've spent quite some time lately trying to update the cookbook by proofreading and testing the examplesand adding new recipes and I think that the cookbook is an invaluable source of informations for PyQGIS programmers, the biggest problem is that it is not routinely updated when the underlying API changes, for instance there are no recipes for <br class=""></div><div class="">QgsMapSettings or QgsMapRendererCustomPainterJob and a few examples use deprecated methods.<br class=""><br class=""></div><div class="">I liked a lot the idea we discussed in Denmark about adding tests directly in the rst sphynx code, this would be a nice improvement for the code examples and snippets.<br class=""><br class=""></div><div class="">I think that the cookbook must continue to exist, it would be awesome if the process of writing code examples could be automated to transfer them to the cookbook, adding the snippets to travis would be a nice start but we all should definitely dedicate more resources for keeping the cookbook in sync with the source code changes.<br class=""><br class=""></div></div></div></div></div></blockquote><div><br class=""></div><div><br class=""></div><div><br class=""></div><div>I also really like the cookbook, though I worry about the maintenance of it - if we can do the tests in ret to make sure that it remains current that would be one good motivation for keeping it current. An alternative approach would be to move the content of the cookbook into doxygen documentation (you can add arbitrary pages there - they don’t all need to be generated from header files. </div><div><br class=""></div><div>But let me rather step back and say that my intention in the proposal was more that we sponsor someone to really look into these things and come up with a well established standard - something like the django folks have done in your link below. We obviously don’t currently have funding for a complete revision of every single source file, but I think if the person we hire can establish a good working system, it will be easier to point others to when they submit patches, telling them ‘we need docs with that!’ - and pointing the to examples and instructions on how to document their code nicely.</div><div><br class=""></div><div>Regards</div><div><br class=""></div><div>Tim</div><br class=""><blockquote type="cite" class=""><div class=""><div dir="ltr" class=""><div class="gmail_extra"><div class="gmail_quote"><div class="">Generally speaking I like a lot how the Django project team handles their (very high quality) documentation [1], the policy is also a bit strict but definitely worth reading [2]: <br class=""></div></div><br clear="all" class=""></div><div class="gmail_extra">Long live the cookbook :)<br class=""><br class=""><br class=""><a href="https://docs.djangoproject.com/en/1.8/" class="">https://docs.djangoproject.com/en/1.8/</a><br class=""><b class=""><a href="http://tinyurl.com/okburu3" class="">http://tinyurl.com/okburu3</a></b><br class="">-- <br class=""><div class="gmail_signature">Alessandro Pasotti<br class="">w3: <a href="http://www.itopen.it/" target="_blank" class="">www.itopen.it</a></div>
</div></div>
_______________________________________________<br class="">Qgis-developer mailing list<br class=""><a href="mailto:Qgis-developer@lists.osgeo.org" class="">Qgis-developer@lists.osgeo.org</a><br class="">http://lists.osgeo.org/mailman/listinfo/qgis-developer</div></blockquote></div><br class=""><div apple-content-edited="true" class="">
<span><img height="60" width="60" apple-inline="yes" id="733E17B8-2E37-40CC-890D-2E6D49076B97" apple-width="yes" apple-height="yes" src="cid:DDEF9B12-67C3-4498-BD7D-EC3563CC35A4" class=""></span><div style="color: rgb(0, 0, 0); font-family: Helvetica; font-size: 12px; font-style: normal; font-variant: normal; font-weight: normal; letter-spacing: normal; line-height: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: auto; word-spacing: 0px; -webkit-text-stroke-width: 0px; word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class=""><div class=""><br class="Apple-interchange-newline"><br class=""></div><div class="">Tim Sutton</div><div class="">QGIS Project Steering Committee Member</div><div class=""><a href="mailto:tim@qgis.org" class="">tim@qgis.org</a></div><div class=""><br class=""></div></div><br class="Apple-interchange-newline" style="color: rgb(0, 0, 0); font-family: Helvetica; font-size: 12px; font-style: normal; font-variant: normal; font-weight: normal; letter-spacing: normal; line-height: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: auto; word-spacing: 0px; -webkit-text-stroke-width: 0px;"><br class="Apple-interchange-newline">
</div>
<br class=""></body></html>