[Qgis-psc] Bugfixing for documentation

[Denis Rouzaud]

Hi Andreas,

I wouldn't say that it's the changing API that is challenging, it's
mainly tackling issues that are spotted from time to time (but also the
long standing one).
The majority of these are not a 10min changes. For example, the last
request to have processing documentation. I thought it was an easy shot,
but at the end, it's about half a day of work (other parts of the API would
benefit from this too).
Also, there is some maintenance effort for the docker images.

I'm partly doing this for free now. The grants in the past have allowed to
put something in place, but it would be great to have some small time
dedicated to this every year.
I would be happy to propose maybe 2 to 3 days a year dedicated to
maintenance and bug fixing.

I do believe that our Python API is a main attraction point, and improving
the API docs is a key point.


Cheers,
Denis


Le jeu. 26 sept. 2019 à 08:28, Andreas Neumann <a.neumann at carto.net> a
écrit :

> Hi,
>
> Hm - We always had a separate budget for documentation - totally separate
> from the grants.
>
> Personally, I would prefer if we could find a pragmatic solution so that
> work, that wasn't planned ahead, can still be financed. Grants are only
> issued once a year - for one-time work - not for repeated maintenance work.
>
> I think our Python devs would appreciate a complete API documentation.
> This seems to be repeating work - isn't the API constantly changing a bit?
> Mainly for major releases, but also some additions, fixes, clarifications,
> etc. in betweeen?
>
> I think, in the future, we should declare API documentation as part of the
> documentation budget and increase the documentation funds accordingly.
>
> Opinions?
>
> Greetings,
>
> Andreas
>
> On 2019-09-26 07:58, Paolo Cavallini wrote:
>
> +1
> Cheers.
>
> On 26 September 2019 06:51:34 CEST, Denis Rouzaud <denis.rouzaud at gmail.com>
> wrote:
>
> Hi Tim,
>
> Fair enough, thanks for letting me know.
>
> Cheers,
> Denis
>
> Le mer. 25 sept. 2019 à 09:11, Tim Sutton <tim at kartoza.com> a écrit :
>
> Hi Denis
>
> For me I apologise for being a party pooper here but I think it is better
> we spend our bug fixing time on actual QGIS bug fixes. If we are going to
> spend more time on the docs I prefer if we work through the grant process.
>
> Regards
>
> Tim
>
> On 24 Sep 2019, at 21:11, Denis Rouzaud <denis.rouzaud at gmail.com> wrote:
>
> Dear psc,
>
> I would like to know if it is possible to spend some bugfixing time on the
> pyqgis documentation bugfixing.
> This is mainly to bring missing parts of the API (processing and missing
> core additions like qgis.core.edit and so). The required time is max 1 day.
>
> Thanks for letting me know.
>
> Denis
> _______________________________________________
> Qgis-psc mailing list
> Qgis-psc at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/qgis-psc
>
>
> —
>
>
>
>
>
>
>
>
> *Tim Sutton*
>
> *Co-founder:* Kartoza
> *Ex Project chair:* QGIS.org
>
> Visit http://kartoza.com to find out about open source:
>
> Desktop GIS programming services
> Geospatial web development
> GIS Training
> Consulting Services
>
> *Skype*: timlinux
> *IRC:* timlinux on #qgis at freenode.net
>
> I'd love to connect. Here's my calendar link
> <https://calendly.com/timlinux> to make finding time easy.
>
>
> --
> Sorry for being short
>
> _______________________________________________
> Qgis-psc mailing list
> Qgis-psc at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/qgis-psc
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20190926/7178b18e/attachment.html>