[QGIS-Developer] Important question!
matthias at opengis.ch
Mon Aug 14 07:37:31 PDT 2017
Thanks for the feedback
Convinced and some first docs fixed in
Glad to have this question answered as well
On 08/14/2017 03:41 PM, Alexandre Neto wrote:
> 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
> <mailto:nyall.dawson at gmail.com>> escreveu:
> On 14 August 2017 at 18:23, Matthias Kuhn <matthias at opengis.ch
> <mailto:matthias at opengis.ch>> wrote:
> > Hi devs,
> > I have just realized that we never decided on a very important
> > so I thought it would be a good point in time to do this now.
> > Should documentation for methods be written in imperative or
> > 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.
> QGIS-Developer mailing list
> QGIS-Developer at lists.osgeo.org <mailto: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
More information about the QGIS-Developer