[Gfoss] Documentazione moduli python per qgis

[Antonio Falciano]

mando ha scritto:
> La cosa strana è che python dovrebbe essere autodocumentante, invece gli

Premetto che non sono un programmatore di professione, nè tantomeno un
esperto di python, ma che python sia autodocumentante non ci giurerei...
http://it.diveintopython.org/getting_to_know_python/documenting_functions.html
Data la sua chiarezza il python è più semplice da comprendere rispetto
ad altri linguaggi e, a volte, la documentazione nel codice potrebbe
sembrare superflua, specie a programmatori esperti, mentre per tutti gli
altri è spesso una necessità. In generale, è sempre consigliabile farlo
poichè se si riprende il codice a distanza di molto tempo è difficile
ricordarsi di tutti i passaggi seguiti ed, inoltre, è più semplice così
riuscire ad isolare un bug partendo da un comportamento inaspettato
dell'applicazione.

> autori dei moduli non hanno commentato i metodi. Chissà perchè, poi. Per
> collaborare, a parte raccogliere tutti gli esempi che trovo in giro e
> modificarli un po' non ho competenze da programmatore, ma se ci fossero
> altri, sarei ben lieto di aiutare, magari anche per le traduzioni.

Per le traduzioni, credo che non sia necessario saper programmare...
Basta semplicemente tradurre tutte le stringhe comprese tra doppi apici. :)

> Intanto metto qua i link che conosco in cui è presente un po' di doc (non
> ricordo se qualcuno li aveva già postati):
> 
> Descrive come iniziare a usare pyQGis, installando SIP, le librerie QT e le
> pyQt:
> http://wiki.qgis.org/qgiswiki/PythonBindings?highlight=%28python%29 
> 
> 6 tutorial per realizzare un'applicazione GIS indipendente:
> http://blog.qgis.org/?q=node/59 
> 
> Una serie di esempi di applicazioni:
> http://trac.infodrizzle.org/openocean/index.cgi/browser/trunk/openoceanmap?rev=4
> 
> un tutorial essenziale su come realizzare un plugin:
> http://www.duif.net/qgis/
> 
> 
> Anche nel tutorial di qgis0.9.0 sono segnalati gli step base per realizzare
> un plugin.

A questa raccolta di link, che costituisce di per sè già una buona base
per iniziare, aggiungerei qualcosa di fondamentale, le API di Qgis:
http://svn.qgis.org/api_doc/html/
mediante le quali si hanno a disposizione tutte le classi e i metodi
utili per programmare Qgis.

Ciao
Antonio