<html><head></head><body>Thanks Ale.<br><br><div class="gmail_quote">On 1 March 2020 18:32:46 CET, Alessandro Pasotti <apasotti@gmail.com> wrote:<blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<pre class="k9mail">On Sun, Mar 1, 2020 at 1:13 PM Paolo Cavallini <cavallini@faunalia.it> wrote:<br><blockquote class="gmail_quote" style="margin: 0pt 0pt 1ex 0.8ex; border-left: 1px solid #729fcf; padding-left: 1ex;"><br> Hi Harrissou,<br> I think everybody agrees in improving documentation, both for devs and<br> for users. Could you ask the proponents to put a formal proposal for<br> funding?<br></blockquote><br>The proponents is me, here is my proposal about the cookbook contents<br>revision (basically copied from my original email):<br><br>make a revision of the current cookbook text and code snippets in order to:<br>- update the text and the code snippets<br>- put ALL code snippets under the existing automated Python test CI<br>infrastructure.<br><br>The current situation (well, current when I wrote the original email<br>but I don't think it has changed):<br><br>- python code samples/snippets: 202<br>- python code samples/snippets currently tested: 53<br><br>My plan is:<br>1. check all the cookbook text for 3.10 (or whatever the LTR will be<br>when I will do the work) API changes and update it accordingly<br>2. put the 149 untested snippets under test<br><br>As far as point 1 is concerned the following files have the<br>'outofdate' directive:<br><br>./source/docs/pyqgis_developer_cookbook/server.rst<br>./source/docs/pyqgis_developer_cookbook/settings.rst<br>./source/docs/pyqgis_developer_cookbook/network_analysis.rst<br>./source/docs/pyqgis_developer_cookbook/canvas.rst<br>./source/docs/pyqgis_developer_cookbook/authentication.rst<br>./source/docs/pyqgis_developer_cookbook/plugins/ide_debugging.rst<br>./source/docs/pyqgis_developer_cookbook/plugins/pluginlayer.rst<br>./source/docs/pyqgis_developer_cookbook/plugins/releasing.rst<br>./source/docs/pyqgis_developer_cookbook/raster.rst<br><br>this of course doesn't mean that all others are necessarily uptodate,<br>but we can assume that they require less work to be updated.<br><br>It's a bit difficult to estimate the exact amount of work required to achieve<br>both tasks, especially because some code samples will require quite a lot<br>of setup and data in order to run in the automatic tests.<br><br>However, I think the most efficient way to proceed is to work on both<br>tasks simultaneously: while checking the code samples it will be easier<br>to also apply corrections to the text.<br><br>Total time required: 5 days at the standard QGIS hourly rate.<br><br>Note that in the original thread was discussed to move the cookbook<br>outside of the documentation, but that task is completely independent<br>from the text and code revision and it is not included in my proposal.<br><br>Regards.<br><br>--<br>Alessandro Pasotti<br>w3: www.itopen.it<br></pre></blockquote></div><br>-- <br>Please excuse my brevity.</body></html>