[Qgis-developer] Documentation of QgsProject.clearProperties

[Anita Graser]

Hi,

I would like to ask for your feedback to improve the documentation
of QgsProject.clearProperties (
http://qgis.org/api//classQgsProject.html#ae23318aec80be782d330ce36097b2e5d).
I'm afraid the current wording is dangerously confusing. Only one of the
last lines gets to the point that it "removes all project properties".

Imho, that should be the first line. And add a fat exclamation mark too.
Currently it reads like the function is totally harmless and only clears
some plugin properties:

syntactic sugar for property lists

extra properties, typically added by plug-ins

This allows for extra properties to be associated with projects. Think of
it as a registry bound to a project.

Properties are arbitrary values keyed by a name and associated with a
scope. The scope would presumably refer to your plug-in. E.g.,
"openmodeller".
... It somehow reads like these lines don't actually belong to this method
but are ment to describe something else.

Would love to hear your thoughts on this.

Thanks and best wishes,
Anita
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20150214/9dc001da/attachment.html>