[QGIS-Developer] Important question!

Alexandre Neto senhor.neto at gmail.com
Mon Aug 14 06:41:01 PDT 2017


I have thought about that for tool tips and documentation (not code), and I
think it sounds better in the descriptive form. I guess for code this is
similar.

A seg, 14/08/2017, 09:40, Nyall Dawson <nyall.dawson at gmail.com> escreveu:

> On 14 August 2017 at 18:23, Matthias Kuhn <matthias at opengis.ch> wrote:
> > Hi devs,
> >
> > I have just realized that we never decided on a very important question,
> > so I thought it would be a good point in time to do this now.
> >
> > Should documentation for methods be written in imperative or descriptive
> > language? In explicit, should it be
> >
> > * "Add a new part to a multi type geometry"
> >
> > or
> >
> > * "Adds a new part to a multi type geometry"
> >
> >
> > I have a tendency for imperative "Add a new part...".
>
> I'd go the other way, and use "adds a new part"/"returns the outline
> color"/etc. Reason is that this is what Qt does, which we've modeled
> other parts of our standards on.
>
> Nyall
> _______________________________________________
> QGIS-Developer mailing list
> QGIS-Developer at lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

-- 
Alexandre Neto
---------------------
@AlexNetoGeo
http://sigsemgrilhetas.wordpress.com
http://gisunchained.wordpress.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20170814/07e0a33f/attachment.html>


More information about the QGIS-Developer mailing list