[QGIS-Developer] Important question!

[Nyall Dawson]

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