[Qgis-psc] PyQgis Cookbook revision

[Marco Bernasocchi]

Hi Alessandro, thanks a lot for the analysis, as I already mentioned in
the docs meeting I think the py cookbook is very important and needs
lots of love.

I like your suggestion and I'd be in favour of doing it.

cheers

Marco

On 19.12.19 15:37, Alessandro Pasotti wrote:
>
> On Wed, Dec 18, 2019 at 8:59 AM Paolo Cavallini <cavallini at faunalia.it
> <mailto:cavallini at faunalia.it>> wrote:
>
>     OK, if it's a quick thing then please submit a proposal and we'll vote
>     it ASAP.
>     Thanks.
>
>
> I've done a quick research, the current cookbook situation appears to be:
>
> - python code samples/snippets: 202
> - python code samples/snippets currently tested: 53
>
> So, I think that the plan would be to:
> 1. check all the cookbook text for 3.10 API changes and update it
> accordingly
> 2. put the 149 untested snippets under test
>
> As far as point 1 is concerned the following files have the
> 'outofdate' directive:
>  
> ./source/docs/pyqgis_developer_cookbook/server.rst
> ./source/docs/pyqgis_developer_cookbook/settings.rst
> ./source/docs/pyqgis_developer_cookbook/network_analysis.rst
> ./source/docs/pyqgis_developer_cookbook/canvas.rst
> ./source/docs/pyqgis_developer_cookbook/authentication.rst
> ./source/docs/pyqgis_developer_cookbook/plugins/ide_debugging.rst
> ./source/docs/pyqgis_developer_cookbook/plugins/pluginlayer.rst
> ./source/docs/pyqgis_developer_cookbook/plugins/releasing.rst
> ./source/docs/pyqgis_developer_cookbook/raster.rst
>
> this of course doesn't mean that all others are necessarily uptodate,
> but we can assume that they require less work to be updated.
>
> It's a bit difficult to estimate the exact amount of work required to
> achieve
> both tasks, especially because some code samples will require quite a lot
> of setup and data in order to run in the automatic tests.
>
> However, I think the most efficient way to proceed is to work on both
> tasks simultaneously: while checking the code samples it will be easier
> to also apply corrections to the text.
>
> So, what I would like to propose is to start with 5 days of work and
> see where we
> can get with that, there are probably some APIs that haven't changed much
> between releases (authentication is an example).
>
> Btw, when looking at this, I've added this small improvement:
> https://github.com/qgis/QGIS-Documentation/pull/4651
>
> Cheers
>
>
>
>     Il 18/12/19 08:57, Alessandro Pasotti ha scritto:
>     >
>     >
>     > On Wed, Dec 18, 2019 at 8:54 AM Paolo Cavallini
>     <cavallini at faunalia.it <mailto:cavallini at faunalia.it>
>     > <mailto:cavallini at faunalia.it <mailto:cavallini at faunalia.it>>>
>     wrote:
>     >
>     >     Hi Ale,
>     >     would this be suitable for a grant project?
>     >
>     >
>     >
>     > You tell me :)
>     >
>     > I thought I would have time to do it now in the next few weeks,
>     but if I
>     > will still have time later in the year I will apply for a grant.
>     >
>     > Cheers
>     >
>     >     Cheers.
>     >
>     >     Il 18/12/19 08:50, Alessandro Pasotti ha scritto:
>     >     > Hi,
>     >     >
>     >     > I'd like like to make a deep revision and update of the
>     cookbook
>     >     and put
>     >     > code snippets under automated testing.
>     >     >
>     >     > Are there any funds left for such activity?
>     >     >
>     >     > --
>     >     > Alessandro Pasotti
>     >     > w3:   www.itopen.it <http://www.itopen.it>
>     <http://www.itopen.it> <http://www.itopen.it>
>     >     >
>     >     > _______________________________________________
>     >     > Qgis-psc mailing list
>     >     > Qgis-psc at lists.osgeo.org <mailto:Qgis-psc at lists.osgeo.org>
>     <mailto:Qgis-psc at lists.osgeo.org <mailto:Qgis-psc at lists.osgeo.org>>
>     >     > https://lists.osgeo.org/mailman/listinfo/qgis-psc
>     >     >
>     >
>     >     --
>     >     Paolo Cavallini - www.faunalia.eu <http://www.faunalia.eu>
>     <http://www.faunalia.eu>
>     >     QGIS.ORG <http://QGIS.ORG> <http://QGIS.ORG> Chair:
>     >     http://planet.qgis.org/planet/user/28/tag/qgis%20board/
>     >     _______________________________________________
>     >     Qgis-psc mailing list
>     >     Qgis-psc at lists.osgeo.org <mailto:Qgis-psc at lists.osgeo.org>
>     <mailto:Qgis-psc at lists.osgeo.org <mailto:Qgis-psc at lists.osgeo.org>>
>     >     https://lists.osgeo.org/mailman/listinfo/qgis-psc
>     >
>     >
>     >
>     > --
>     > Alessandro Pasotti
>     > w3:   www.itopen.it <http://www.itopen.it> <http://www.itopen.it>
>
>     -- 
>     Paolo Cavallini - www.faunalia.eu <http://www.faunalia.eu>
>     QGIS.ORG <http://QGIS.ORG> Chair:
>     http://planet.qgis.org/planet/user/28/tag/qgis%20board/
>
>
>
> -- 
> Alessandro Pasotti
> w3:   www.itopen.it <http://www.itopen.it>
>
> _______________________________________________
> Qgis-psc mailing list
> Qgis-psc at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/qgis-psc

-- 
Marco Bernasocchi

QGIS.org Co-chair
http://berna.io

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20191219/f1aaeb8c/attachment.html>